searcherator 0.0.1__tar.gz

searcherator-0.0.1/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: searcherator
+Version: 0.0.1
+Summary: A Python package for performing cached web searches using the Brave Search API
+Author-email: Arved Klöhn <arved.kloehn@gmail.com>
+Project-URL: Homepage, https://github.com/Redundando/searcherator
+Project-URL: Bug Tracker, https://github.com/Redundando/searcherator/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: cacherator
+Requires-Dist: logorator
+Requires-Dist: aiohttp
+
+# Searcherator
+
+Searcherator is a Python package that provides a convenient way to perform web searches using the Brave Search API with built-in caching capabilities.
+
+## Installation
+
+```bash
+pip install searcherator
+```
+
+## Requirements
+
+- Python 3.8+
+- Brave Search API key
+
+## Usage
+
+```python
+from searcherator import Searcherator
+import asyncio
+
+async def main():
+    # Basic search in English (US)
+    search = Searcherator("Python programming language")
+    
+    # Get URLs from search results
+    urls = await search.urls()
+    print(urls)
+    
+    # German search with more results
+    german_search = Searcherator(
+        "Zusammenfassung Buch 'Demian' von 'Hermann Hesse'",
+        language="de",
+        country="de",
+        num_results=10
+    )
+    
+    # Print full search results
+    await german_search.print()
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## API Reference
+
+### Searcherator
+
+```python
+Searcherator(
+    search_term: str = "",
+    num_results: int = 5,
+    country: str | None = "us",
+    language: str | None = "en",
+    api_key: str | None = None,
+    clear_cache: bool = False,
+    ttl: int = 7
+)
+```
+
+#### Parameters
+
+- `search_term`: The query string to search for
+- `num_results`: Maximum number of results to return (default: 5)
+- `country`: Country code for search results (default: "us")
+- `language`: Language code for search results (default: "en")
+- `api_key`: Brave Search API key (default: None, will try to use BRAVE_API_KEY environment variable)
+- `clear_cache`: Whether to clear existing cached results (default: False)
+- `ttl`: Time-to-live for cached results in days (default: 7)
+
+#### Methods
+
+- `async urls() -> list[str]`: Returns a list of URLs from the search results
+- `async search_result() -> dict`: Returns the full search results as a dictionary
+- `async print()`: Prints the full search results in a formatted way
+
+## Authentication
+
+Set your Brave Search API key as an environment variable:
+
+```bash
+export BRAVE_API_KEY="your-api-key-here"
+```
+
+Alternatively, provide the API key directly when initializing the Searcherator:
+
+```python
+search = Searcherator("My search term", api_key="your-api-key-here")
+```
+
+## License
+
+MIT License
+
+## Author
+
+Arved Klöhn - [GitHub](https://github.com/Redundando/)

searcherator-0.0.1/README.md

@@ -0,0 +1,97 @@
+# Searcherator
+
+Searcherator is a Python package that provides a convenient way to perform web searches using the Brave Search API with built-in caching capabilities.
+
+## Installation
+
+```bash
+pip install searcherator
+```
+
+## Requirements
+
+- Python 3.8+
+- Brave Search API key
+
+## Usage
+
+```python
+from searcherator import Searcherator
+import asyncio
+
+async def main():
+    # Basic search in English (US)
+    search = Searcherator("Python programming language")
+    
+    # Get URLs from search results
+    urls = await search.urls()
+    print(urls)
+    
+    # German search with more results
+    german_search = Searcherator(
+        "Zusammenfassung Buch 'Demian' von 'Hermann Hesse'",
+        language="de",
+        country="de",
+        num_results=10
+    )
+    
+    # Print full search results
+    await german_search.print()
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## API Reference
+
+### Searcherator
+
+```python
+Searcherator(
+    search_term: str = "",
+    num_results: int = 5,
+    country: str | None = "us",
+    language: str | None = "en",
+    api_key: str | None = None,
+    clear_cache: bool = False,
+    ttl: int = 7
+)
+```
+
+#### Parameters
+
+- `search_term`: The query string to search for
+- `num_results`: Maximum number of results to return (default: 5)
+- `country`: Country code for search results (default: "us")
+- `language`: Language code for search results (default: "en")
+- `api_key`: Brave Search API key (default: None, will try to use BRAVE_API_KEY environment variable)
+- `clear_cache`: Whether to clear existing cached results (default: False)
+- `ttl`: Time-to-live for cached results in days (default: 7)
+
+#### Methods
+
+- `async urls() -> list[str]`: Returns a list of URLs from the search results
+- `async search_result() -> dict`: Returns the full search results as a dictionary
+- `async print()`: Prints the full search results in a formatted way
+
+## Authentication
+
+Set your Brave Search API key as an environment variable:
+
+```bash
+export BRAVE_API_KEY="your-api-key-here"
+```
+
+Alternatively, provide the API key directly when initializing the Searcherator:
+
+```python
+search = Searcherator("My search term", api_key="your-api-key-here")
+```
+
+## License
+
+MIT License
+
+## Author
+
+Arved Klöhn - [GitHub](https://github.com/Redundando/)

searcherator-0.0.1/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "searcherator"
+version = "0.0.1"
+authors = [
+  { name="Arved Klöhn", email="arved.kloehn@gmail.com" },
+]
+description = "A Python package for performing cached web searches using the Brave Search API"
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "cacherator",
+    "logorator",
+    "aiohttp",
+]
+
+[tool.setuptools]
+packages = [
+"searcherator"
+]
+
+[project.urls]
+"Homepage" = "https://github.com/Redundando/searcherator"
+"Bug Tracker" = "https://github.com/Redundando/searcherator/issues"

searcherator-0.0.1/searcherator/__init__.py

@@ -0,0 +1 @@
+from .searcherator import Searcherator

searcherator-0.0.1/searcherator/searcherator.py

@@ -0,0 +1,71 @@
+import asyncio
+import os
+from pprint import pprint
+
+import aiohttp
+from cacherator import Cached, JSONCache
+from logorator import Logger
+
+
+class Searcherator(JSONCache):
+
+    def __init__(
+            self,
+            search_term="",
+            num_results: int = 5,
+            country: str | None = "us",
+            language: str | None = "en",
+            api_key: str | None = None,
+            clear_cache=False,
+            ttl=7):
+        self.api_key = api_key
+        if api_key is None:
+            try:
+                self.api_key = os.getenv("BRAVE_API_KEY")
+            except KeyError:
+                self.api_key = None
+        self._search_results = None
+        self._urls = None
+        super().__init__(data_id=f"{search_term} ({language} {country} {num_results})", directory="data/search", clear_cache=clear_cache, ttl=ttl)
+        self.search_term = search_term
+        self.num_results = num_results
+        self.language = language
+        self.country = country
+
+    def __str__(self):
+        return f"Search: {self.search_term}"
+
+    def __repr__(self):
+        return self.__str__()
+
+    @Logger()
+    async def async_search(self):
+        if self._search_results is None:
+            url = 'https://api.search.brave.com/res/v1/web/search'
+            headers = {'Accept': 'application/json', 'X-Subscription-Token': self.api_key, }
+            params = {'q': self.search_term, 'count': self.num_results, 'country': self.country, 'search_lang': self.language, 'spellcheck': 'false'}
+            async with aiohttp.ClientSession() as session:
+                async with session.get(url, headers=headers, params=params) as response:
+                    if response.status == 200:
+                        self._search_results = await response.json()
+                    else:
+                        Logger.note(f"Error: {response.status} - {await response.text()}")
+        return self._search_results
+
+    async def urls(self):
+        if self._urls is None:
+            self._urls = []
+            search_results = await self.search_result()
+            for result in search_results.get("web", {}).get("results", []):
+                self._urls.append(result["url"])
+        return self._urls
+
+    async def search_result(self):
+        if self._search_results is None:
+            self._search_results = await self.async_search()
+        return self._search_results
+
+    async def print(self):
+        pprint(await self.search_result(), width=200, indent=2)
+
+

searcherator-0.0.1/searcherator.egg-info/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: searcherator
+Version: 0.0.1
+Summary: A Python package for performing cached web searches using the Brave Search API
+Author-email: Arved Klöhn <arved.kloehn@gmail.com>
+Project-URL: Homepage, https://github.com/Redundando/searcherator
+Project-URL: Bug Tracker, https://github.com/Redundando/searcherator/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: cacherator
+Requires-Dist: logorator
+Requires-Dist: aiohttp
+
+# Searcherator
+
+Searcherator is a Python package that provides a convenient way to perform web searches using the Brave Search API with built-in caching capabilities.
+
+## Installation
+
+```bash
+pip install searcherator
+```
+
+## Requirements
+
+- Python 3.8+
+- Brave Search API key
+
+## Usage
+
+```python
+from searcherator import Searcherator
+import asyncio
+
+async def main():
+    # Basic search in English (US)
+    search = Searcherator("Python programming language")
+    
+    # Get URLs from search results
+    urls = await search.urls()
+    print(urls)
+    
+    # German search with more results
+    german_search = Searcherator(
+        "Zusammenfassung Buch 'Demian' von 'Hermann Hesse'",
+        language="de",
+        country="de",
+        num_results=10
+    )
+    
+    # Print full search results
+    await german_search.print()
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## API Reference
+
+### Searcherator
+
+```python
+Searcherator(
+    search_term: str = "",
+    num_results: int = 5,
+    country: str | None = "us",
+    language: str | None = "en",
+    api_key: str | None = None,
+    clear_cache: bool = False,
+    ttl: int = 7
+)
+```
+
+#### Parameters
+
+- `search_term`: The query string to search for
+- `num_results`: Maximum number of results to return (default: 5)
+- `country`: Country code for search results (default: "us")
+- `language`: Language code for search results (default: "en")
+- `api_key`: Brave Search API key (default: None, will try to use BRAVE_API_KEY environment variable)
+- `clear_cache`: Whether to clear existing cached results (default: False)
+- `ttl`: Time-to-live for cached results in days (default: 7)
+
+#### Methods
+
+- `async urls() -> list[str]`: Returns a list of URLs from the search results
+- `async search_result() -> dict`: Returns the full search results as a dictionary
+- `async print()`: Prints the full search results in a formatted way
+
+## Authentication
+
+Set your Brave Search API key as an environment variable:
+
+```bash
+export BRAVE_API_KEY="your-api-key-here"
+```
+
+Alternatively, provide the API key directly when initializing the Searcherator:
+
+```python
+search = Searcherator("My search term", api_key="your-api-key-here")
+```
+
+## License
+
+MIT License
+
+## Author
+
+Arved Klöhn - [GitHub](https://github.com/Redundando/)

searcherator-0.0.1/searcherator.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+README.md
+pyproject.toml
+searcherator/__init__.py
+searcherator/searcherator.py
+searcherator.egg-info/PKG-INFO
+searcherator.egg-info/SOURCES.txt
+searcherator.egg-info/dependency_links.txt
+searcherator.egg-info/requires.txt
+searcherator.egg-info/top_level.txt

searcherator-0.0.1/searcherator.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

searcherator-0.0.1/searcherator.egg-info/requires.txt

@@ -0,0 +1,3 @@
+cacherator
+logorator
+aiohttp

searcherator-0.0.1/searcherator.egg-info/top_level.txt

@@ -0,0 +1 @@
+searcherator

searcherator-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+