Skip to content

Commit

Permalink
update export list, readme.md and product version
Browse files Browse the repository at this point in the history
  • Loading branch information
nwaughachukwuma committed Nov 18, 2024
1 parent 4d846f8 commit 68c91a5
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 9 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ pip install async-web-search
### Example 1: Search across multiple sources

```python
from web_search import WebSearch, WebSearchConfig, GoogleSearchConfig
from web_search import WebSearch, WebSearchConfig

config = WebSearchConfig(sources=["google", "arxiv"])
results = await WebSearch(config).search("quantum computing")
Expand All @@ -48,7 +48,8 @@ print(results)
### Example 2: Google Search

```python
from web_search import GoogleSearch, GoogleSearchConfig
from web_search import GoogleSearchConfig
from web_search.google import GoogleSearch

config = GoogleSearchConfig(
api_key="your_google_api_key",
Expand All @@ -64,7 +65,8 @@ for result in results:
### Example 3: Wikipedia Search

```python
from web_search import WikipediaSearch, BaseConfig
from web_search import BaseConfig
from web_search.wikipedia import WikipediaSearch

wiki_config = BaseConfig(max_results=5, max_preview_chars=500)
results = await WikipediaSearch(wiki_config)._search("deep learning")
Expand All @@ -76,7 +78,8 @@ for result in results:
### Example 4: ArXiv Search

```python
from web_search import ArxivSearch, BaseConfig
from web_search import BaseConfig
from web_search.arxiv import ArxivSearch

arxiv_config = BaseConfig(max_results=3, max_preview_chars=800)
results = await ArxivSearch(arxiv_config)._search("neural networks")
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ build-backend = "hatchling.build"
[project]
name = "async-web-search"
requires-python = ">=3.9"
version = "0.2.0"
version = "0.2.1"
description = "Async web search library supporting Google, Wikipedia, and arXiv"

readme = "README.md"
Expand Down
8 changes: 4 additions & 4 deletions src/web_search/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@
from .search import WebSearch

__all__ = [
"WebSearch",
"WebSearchConfig",
"GoogleSearchConfig",
"BaseConfig",
"BaseSearch",
"GoogleSearchConfig",
"SearchSources",
"SearchResult",
"BaseSearch",
"WebSearch",
"WebSearchConfig",
]

0 comments on commit 68c91a5

Please sign in to comment.