-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4c20e6e
commit 6620699
Showing
8 changed files
with
342 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| ## Further Reading | ||
|
|
||
| * Check out the [reference](https://brave-search-python-client.readthedocs.io/en/latest/reference.html) with detailed documentation of public classes and functions. | ||
| * Our [release notes](https://brave-search-python-client.readthedocs.io/en/latest/release-notes.html) provide a complete log of recent improvements and changes. | ||
| * In case you want to help us improve the Brave Search Python Client: The [contribution guidelines](https://brave-search-python-client.readthedocs.io/en/latest/contributing.html) explain how to setup your development environment and create pull requests. | ||
|
|
||
| ## Star History | ||
|
|
||
| <a href="https://star-history.com/#helmut-hoffer-von-ankershoffen/brave-search-python-client&Date"> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/brave-search-python-client&type=Date&theme=dark" /> | ||
| <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/brave-search-python-client&type=Date" /> | ||
| <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/brave-search-python-client&type=Date" /> | ||
| </picture> | ||
| </a> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| # 🦁 Brave Search Python Client | ||
|
|
||
| [ | ||
| ](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/LICENSE) | ||
| [](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/noxfile.py) | ||
| [](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/actions/workflows/test-and-report.yml) | ||
| [](https://brave-search-python-client.readthedocs.io/) | ||
| [](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_brave-search-python-client) | ||
| [](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_brave-search-python-client) | ||
| [](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_brave-search-python-client) | ||
| [](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_brave-search-python-client) | ||
| [](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_brave-search-python-client) | ||
| [](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/brave-search-python-client) | ||
| [](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/noxfile.py) | ||
| [](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-clientidge/releases) | ||
|  | ||
| [](https://pypi.python.org/pypi/brave-search-python-client) | ||
| [](https://pypi.python.org/pypi/brave-search-python-client) | ||
| [](https://hub.docker.com/r/helmuthva/brave-search-python-client/tags) | ||
| [](https://hub.docker.com/r/helmuthva/brave-search-python-client/) | ||
| <!--- | ||
| [](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/pkgs/container/brave-search-python-client) | ||
| [](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/pkgs/container/brave-search-python-client) | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,286 @@ | ||
| The Brave Search Python Client provides Web, Image, News, and Video search capabilities. | ||
|
|
||
| Use Cases: | ||
| 1) Integrate into your Python code to help users find what they're looking for. | ||
| 2) Add to your AI applications to give LLMs access to current web information. | ||
| 3) Use the built-in CLI in shell scripts to get search results in JSON format. | ||
|
|
||
| ## Overview | ||
|
|
||
| Installation is as simple as: | ||
|
|
||
| ```shell | ||
| uv add brave-search-python-client # add dependency to your project | ||
| ``` | ||
|
|
||
| If you don't have uv installed follow [these instructions](https://docs.astral.sh/uv/getting-started/installation/). If you still prefer pip over the modern and fast package manager [uv](https://github.com/astral-sh/uv), you can install the library like this: | ||
|
|
||
| ```shell | ||
| pip install brave-search-python-client # add dependency to your project | ||
| ``` | ||
|
|
||
| Obtain your Brave Search API key by [signing up here](https://brave.com/search/api/) - the free tier includes 2,000 requests per month. For guidance on how to integrate the Brave Search Python client into your code base check out the examples below and explore the [reference documentation](https://brave-search-python-client.readthedocs.io/en/latest/reference.html). If you just want to try out the client without having to write code you can use the integrated CLI: | ||
|
|
||
| ```shell | ||
| export BRAVE_SEARCH_API_KEY=YOUR_API_KEY # replace YOUR_API_KEY | ||
| uvx brave-search-python-client web "hello world" # search for hello world | ||
| ``` | ||
|
|
||
| All advanced search options of Brave Search are supported [by the client](https://brave-search-python-client.readthedocs.io/en/latest/reference.html#brave_search_python_client.WebSearchRequest) and in the CLI: | ||
|
|
||
| ```shell | ||
| # Find all German content about AI added in the last 24 hours | ||
| uvx brave-search-python-client web --country=DE --search-lang=de --units=metric --freshness=pd ai | ||
| ``` | ||
|
|
||
| The CLI provides extensive help: | ||
|
|
||
| ```shell | ||
| uvx brave-search-python-client --help # all CLI commands | ||
| uvx brave-search-python-client web --help # all options for web search | ||
| uvx brave-search-python-client images --help # all options image search | ||
| uvx brave-search-python-client videos --help # all options video search | ||
| uvx brave-search-python-client news --help # all options news search | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| ## Highlights | ||
|
|
||
| * Modern async Python client for Web, Image, Video and News search powered by [Brave Search](https://brave.com/search/api/) | ||
| * Various Examples: | ||
| - [Streamlit web application](https://brave-search-python-client.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud) | ||
| - [Jupyter notebook](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/examples/jupyter.ipynb) | ||
| - [Simple Python script](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/examples/script.py) | ||
| * Thorough validation of both [requests](https://brave-search-python-client.readthedocs.io/en/latest/reference.html#brave_search_python_client.WebSearchRequest) and [responses](https://brave-search-python-client.readthedocs.io/en/latest/reference.html#brave_search_python_client.WebSearchApiResponse) (powered by Pydantic) | ||
| * [Complete reference documenation](https://brave-search-python-client.readthedocs.io/en/latest/reference.html#brave_search_python_client.BraveSearch) on Read the Docs | ||
| * [100% test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/brave-search-python-client) including unit and E2E tests (reported on Codecov) | ||
| * Matrix tested with [Python 3.11, 3.12 and 3.13](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/noxfile.py) to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/)) | ||
| * 100% compliant with modern linting and formatting standards (powered by [Ruff](https://github.com/astral-sh/ruff)) | ||
| * 100% up-to-date dependencies (monitored by [Renovate](https://github.com/renovatebot/renovate)) | ||
| * [A-grade code quality](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_brave-search-python-client) in security, maintainability, and reliability with 0 technical debt and 0 codesmell (verified by SonarQube) | ||
| * 1-liner for installation and execution of command line interface (CLI) via [uv(x)](https://github.com/astral-sh/uv) or [Docker](https://hub.docker.com/r/helmuthva/brave-search-python-client/tags) | ||
| * Setup for developing inside a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) included (supports VSCode and GitHub Codespaces) | ||
| * Later: [MCP server](https://www.anthropic.com/news/model-context-protocol) to connect Brave Search with Claude Desktop and other MCP clients | ||
|
|
||
| ## Usage Examples | ||
|
|
||
| ### Streamlit App | ||
|
|
||
|  | ||
|
|
||
| [Try it out!](https://brave-search-python-client.streamlit.app) - [Show the code](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/examples/streamlit.py) | ||
|
|
||
|
|
||
| ### Minimal Python Script: | ||
|
|
||
| ```python | ||
| """ | ||
| Example script demonstrating the usage of the Brave Search Python Client. | ||
| For web, image, video and news search. | ||
| """ | ||
|
|
||
| import asyncio | ||
| import os | ||
|
|
||
| from dotenv import load_dotenv | ||
|
|
||
| from brave_search_python_client import ( | ||
| BraveSearch, | ||
| CountryCode, | ||
| ImagesSearchRequest, | ||
| LanguageCode, | ||
| NewsSearchRequest, | ||
| VideosSearchRequest, | ||
| WebSearchRequest, | ||
| ) | ||
|
|
||
| # Load .env file and get Brave Search API key from environment | ||
| load_dotenv() | ||
| api_key = os.getenv("BRAVE_SEARCH_API_KEY") | ||
| if not api_key: | ||
| msg = "BRAVE_SEARCH_API_KEY not found in environment" | ||
| raise ValueError(msg) | ||
|
|
||
|
|
||
| async def search() -> None: | ||
| """Run various searches using the Brave Search Python Client (see https://brave-search-python-client.readthedocs.io/en/latest/reference.html).""" | ||
| # Initialize the Brave Search Python client, using the API key from the environment | ||
| bs = BraveSearch() | ||
|
|
||
| # Perform a web search | ||
| response = await bs.web(WebSearchRequest(q="jupyter")) | ||
|
|
||
| # Print results as JSON | ||
|
|
||
| # Iterate over web hits and render links in markdown | ||
| for _result in response.web.results if response.web else []: | ||
| pass | ||
|
|
||
| # Advanced search with parameters | ||
| response = await bs.web( | ||
| WebSearchRequest( | ||
| q="python programming", | ||
| country=CountryCode.DE, | ||
| search_lang=LanguageCode.DE, | ||
| ), | ||
| ) | ||
| for _result in response.web.results if response.web else []: | ||
| pass | ||
|
|
||
| # Search and render images | ||
| response = await bs.images(ImagesSearchRequest(q="cute cats")) | ||
| for _image in response.results or []: | ||
| pass | ||
|
|
||
| # Search and render videos | ||
| response = await bs.videos(VideosSearchRequest(q="singularity is close")) | ||
| for _video in response.results or []: | ||
| pass | ||
|
|
||
| # Search and render news | ||
| response = await bs.news(NewsSearchRequest(q="AI")) | ||
| for _item in response.results or []: | ||
| pass | ||
|
|
||
|
|
||
| # Run the async search function | ||
| # Alternatively use await search() from an async function | ||
| asyncio.run(search()) | ||
| ``` | ||
|
|
||
| [Show script code](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/examples/script.py) - [Read the reference documentation](https://brave-search-python-client.readthedocs.io/en/latest/reference.html#brave_search_python_client.BraveSearch) | ||
|
|
||
| ## Jupyter Notebook | ||
|
|
||
|  | ||
|
|
||
| [Show notebook code](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/examples/jupyter.ipynb) | ||
|
|
||
|
|
||
| ## Command Line Interface (CLI) | ||
|
|
||
| ### Run with [uvx](https://docs.astral.sh/uv/guides/tools/) | ||
|
|
||
| Add Brave Search API key to the environment | ||
|
|
||
| ```shell | ||
| export BRAVE_SEARCH_API_KEY=YOUR_API_KEY | ||
| ``` | ||
|
|
||
| Show available commands: | ||
|
|
||
| ```shell | ||
| uvx brave-search-python-client --help | ||
| ``` | ||
|
|
||
| Search the web for "hello world": | ||
|
|
||
| ```shell | ||
| uvx brave-search-python-client web "hello world" | ||
| ``` | ||
|
|
||
| Show options for web search | ||
|
|
||
| ```shell | ||
| uvx brave-search-python-client web --help | ||
| ``` | ||
|
|
||
| Search images: | ||
|
|
||
| ```shell | ||
| uvx brave-search-python-client images "hello world" | ||
| ``` | ||
|
|
||
| Show options for image search | ||
|
|
||
| ```shell | ||
| uvx brave-search-python-client images --help | ||
| ``` | ||
|
|
||
| Search videos: | ||
|
|
||
| ```shell | ||
| uvx brave-search-python-client videos "hello world" | ||
| ``` | ||
|
|
||
| Show options for videos search | ||
|
|
||
| ```shell | ||
| uvx brave-search-python-client videos --help | ||
| ``` | ||
|
|
||
| Search news: | ||
|
|
||
| ```shell | ||
| uvx brave-search-python-client news "hello world" | ||
| ``` | ||
|
|
||
| Show options for news search | ||
|
|
||
| ```shell | ||
| uvx brave-search-python-client news --help | ||
| ``` | ||
|
|
||
| ### Run with Docker | ||
|
|
||
| Note: Replace YOUR_BRAVE_SEARCH_API_KEY with your API key in the following examples. | ||
|
|
||
| Show available commands: | ||
|
|
||
| ```bash | ||
| docker run helmuthva/brave-search-python-client --help | ||
| ``` | ||
|
|
||
| Search the web: | ||
|
|
||
| ```bash | ||
| docker run --env BRAVE_SEARCH_API_KEY=YOUR_BRAVE_SEARCH_API_KEY helmuthva/brave-search-python-client web "hello world" | ||
| ``` | ||
|
|
||
| Show options for web search | ||
|
|
||
| ```bash | ||
| docker run helmuthva/brave-search-python-client web --help | ||
| ``` | ||
|
|
||
| Search images: | ||
|
|
||
| ```bash | ||
| docker run --env BRAVE_SEARCH_API_KEY=YOUR_BRAVE_SEARCH_API_KEY helmuthva/brave-search-python-client images "hello world" | ||
| ``` | ||
|
|
||
| Show options for image search | ||
|
|
||
| ```bash | ||
| docker run helmuthva/brave-search-python-client images --help | ||
| ``` | ||
|
|
||
| Search videos: | ||
|
|
||
| ```bash | ||
| docker run --env BRAVE_SEARCH_API_KEY=YOUR_BRAVE_SEARCH_API_KEY helmuthva/brave-search-python-client videos "hello world" | ||
| ``` | ||
|
|
||
| Show options for video search | ||
|
|
||
| ```bash | ||
| docker run helmuthva/brave-search-python-client videos --help | ||
| ``` | ||
|
|
||
| Search news: | ||
|
|
||
| ```bash | ||
| docker run --env BRAVE_SEARCH_API_KEY=YOUR_BRAVE_SEARCH_API_KEY helmuthva/brave-search-python-client news "hello world" | ||
| ``` | ||
|
|
||
| Show options for news search | ||
|
|
||
| ```bash | ||
| docker run helmuthva/brave-search-python-client news --help | ||
| ``` | ||
|
|
||
| ## Extra: MCP Server | ||
|
|
||
| TK (to come) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| .. mdinclude:: ../../_readme_main.md | ||
| :start-line: 0 |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters