Merge pull request #25 from mike-gee/fix/0.3.1/fix-reference-issue

Fix/0.3.1/fix reference issue

Author: mike-gee

README.md

@@ -77,7 +77,7 @@ scraper = webt.Scraper(
 out_json = scraper.scrape("https://www.example.com")
 ```
 
-## Web Search (SERP API)
+## Web Search (AI SERP API)
 
 ```python
 import webtranspose as webt

pyproject.toml

@@ -1,8 +1,8 @@
 
 [tool.poetry]
 name = "webtranspose"
-version = "0.3.0"
-description = "APIs for the internet"
+version = "0.3.1"
+description = "Reliable APIs for the website data"
 authors = ["Mike Gee <[email protected]>"]
 
 readme = "README.md"

src/webtranspose/__init__.py

@@ -2,7 +2,7 @@
 
 __author__ = """Mike Gee"""
 __email__ = "[email protected]"
-__version__ = "0.3.0"
+__version__ = "0.3.1"
 
 from .chat import *
 from .crawl import *

src/webtranspose/search.py

@@ -3,8 +3,17 @@
 
 from .webt_api import run_webt_api
 
+def search(query, api_key=None) -> dict:
+    """
+    Search for a query using the Web Transpose API.
 
-def search(query):
+    Args:
+        query (str): The query to search for.
+        api_key (str, optional): The API key to use for authentication. Defaults to None.
+
+    Returns:
+        dict: The search results.
+    """
     if api_key is None:
         api_key = os.environ.get("WEBTRANSPOSE_API_KEY")
 
@@ -21,7 +30,17 @@ def search(query):
     raise ValueError("Must provide api_key or set WEBTRANSPOSE_API_KEY in environment variables.")
 
 
-def search_filter(query):
+def search_filter(query, api_key=None) -> dict:
+    """
+    Search for a query using the Web Transpose API with filtering.
+
+    Args:
+        query (str): The query to search for.
+        api_key (str, optional): The API key to use for authentication. Defaults to None.
+
+    Returns:
+        dict: The filtered search results.
+    """
     if api_key is None:
         api_key = os.environ.get("WEBTRANSPOSE_API_KEY")