| Name | brave-search-python-client JSON |
| Version |
0.2.15
JSON |
| download |
| home_page | None |
| Summary | 🦁 Brave Search Python Client supporting Web, Image, News and Video search. |
| upload_time | 2025-01-03 10:06:53 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4.0,>=3.11 |
| license | MIT License Copyright (c) [2024] [Helmut Hoffer von Ankershoffen (helmuthva@googlemail.com)] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
api
async
brave
brave-api
brave-search
bravesearch
bravesearchapi
codecov
docker
pydantic
python
ruff
search
sonarqube
typer
uv
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 🦁 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)
-->
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_index.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_index.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_index.html#brave_search_python_client.WebSearchRequest) and [responses](https://brave-search-python-client.readthedocs.io/en/latest/reference_index.html#brave_search_python_client.WebSearchApiResponse) (powered by Pydantic)
* [Complete reference documenation](https://brave-search-python-client.readthedocs.io/en/latest/reference_index.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
import asyncio
import json
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:
raise Exception("BRAVE_SEARCH_API_KEY not found in environment")
async def search():
"""Run various searches using the Brave Search Python Client (see https://brave-search-python-client.readthedocs.io/en/latest/reference_index.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
print("# Web search")
print("## JSON response")
print(json.dumps(response.model_dump(), indent=2))
# Iterate over web hits and render links in markdown
print("## Iterate and render")
for result in response.web.results if response.web else []:
print(f"[{result.title}]({result.url})")
# Advanced search with parameters
response = await bs.web(
WebSearchRequest(
q="python programming",
country=CountryCode.DE,
search_lang=LanguageCode.DE,
)
)
print("# Advanced search results")
for result in response.web.results if response.web else []:
print(f"[{result.title}]({result.url})")
# Search and render images
print("# Images")
response = await bs.images(ImagesSearchRequest(q="cute cats"))
for image in response.results if response.results else []:
print(f"")
# Search and render videos
print("# Videos")
response = await bs.videos(VideosSearchRequest(q="singularity is close"))
for video in response.results if response.results else []:
print(f"")
# Search and render news
print("# News")
response = await bs.news(NewsSearchRequest(q="AI"))
for item in response.results if response.results else []:
print(f"")
# 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_index.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
## Contributing
Please read our [Contributing Guidelines](https://brave-search-python-client.readthedocs.io/en/latest/contributing.html) for how to setup your development environment, and guidance for making pull requests.
## Resources
* [API](https://brave.com/search/api/)
* [MCP Specification and SDKs](https://github.com/modelcontextprotocol)
## 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>
Raw data
{
"_id": null,
"home_page": null,
"name": "brave-search-python-client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "api, async, brave, brave-api, brave-search, bravesearch, bravesearchapi, codecov, docker, pydantic, python, ruff, search, sonarqube, typer, uv",
"author": null,
"author_email": "Helmut Hoffer von Ankershoffen <helmuthva@googlemail.com>",
"download_url": "https://files.pythonhosted.org/packages/c0/b9/98842dc1b4b88b5abe79a7dbc0c34283e1992792ef9c2e7bf4a95faf78c3/brave_search_python_client-0.2.15.tar.gz",
"platform": null,
"description": "# \ud83e\udd81 Brave Search Python Client\n\n[\n](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/LICENSE)\n[](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/noxfile.py)\n[](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/actions/workflows/test-and-report.yml)\n[](https://brave-search-python-client.readthedocs.io/)\n[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_brave-search-python-client)\n[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_brave-search-python-client)\n[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_brave-search-python-client)\n[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_brave-search-python-client)\n[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_brave-search-python-client)\n[](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/brave-search-python-client)\n[](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/noxfile.py)\n[](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-clientidge/releases)\n\n[](https://pypi.python.org/pypi/brave-search-python-client)\n[](https://pypi.python.org/pypi/brave-search-python-client)\n[](https://hub.docker.com/r/helmuthva/brave-search-python-client/tags)\n[](https://hub.docker.com/r/helmuthva/brave-search-python-client/)\n<!---\n[](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/pkgs/container/brave-search-python-client)\n[](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/pkgs/container/brave-search-python-client)\n-->\n\nThe Brave Search Python Client provides Web, Image, News, and Video search capabilities.\n\nUse Cases:\n1) Integrate into your Python code to help users find what they're looking for.\n2) Add to your AI applications to give LLMs access to current web information.\n3) Use the built-in CLI in shell scripts to get search results in JSON format.\n\n## Overview\n\nInstallation is as simple as:\n\n```shell\nuv add brave-search-python-client # add dependency to your project\n```\n\nIf 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:\n\n```shell\npip install brave-search-python-client # add dependency to your project\n```\n\nObtain 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_index.html). If you just want to try out the client without having to write code you can use the integrated CLI:\n\n```shell\nexport BRAVE_SEARCH_API_KEY=YOUR_API_KEY # replace YOUR_API_KEY\nuvx brave-search-python-client web \"hello world\" # search for hello world\n```\n\nAll advanced search options of Brave Search are supported [by the client](https://brave-search-python-client.readthedocs.io/en/latest/reference_index.html#brave_search_python_client.WebSearchRequest) and in the CLI:\n\n```shell\n# Find all German content about AI added in the last 24 hours\nuvx brave-search-python-client web --country=DE --search-lang=de --units=metric --freshness=pd ai\n```\n\nThe CLI provides extensive help:\n\n```shell\nuvx brave-search-python-client --help # all CLI commands\nuvx brave-search-python-client web --help # all options for web search\nuvx brave-search-python-client images --help # all options image search\nuvx brave-search-python-client videos --help # all options video search\nuvx brave-search-python-client news --help # all options news search\n```\n\n\n\n## Highlights\n\n* Modern async Python client for Web, Image, Video and News search powered by [Brave Search](https://brave.com/search/api/)\n* Various Examples:\n - [Streamlit web application](https://brave-search-python-client.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)\n - [Jupyter notebook](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/examples/jupyter.ipynb)\n - [Simple Python script](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/examples/script.py)\n* Thorough validation of both [requests](https://brave-search-python-client.readthedocs.io/en/latest/reference_index.html#brave_search_python_client.WebSearchRequest) and [responses](https://brave-search-python-client.readthedocs.io/en/latest/reference_index.html#brave_search_python_client.WebSearchApiResponse) (powered by Pydantic)\n* [Complete reference documenation](https://brave-search-python-client.readthedocs.io/en/latest/reference_index.html#brave_search_python_client.BraveSearch) on Read the Docs\n* [100% test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/brave-search-python-client) including unit and E2E tests (reported on Codecov)\n* 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/))\n* 100% compliant with modern linting and formatting standards (powered by [Ruff](https://github.com/astral-sh/ruff))\n* 100% up-to-date dependencies (monitored by [Renovate](https://github.com/renovatebot/renovate))\n* [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)\n* 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)\n* Setup for developing inside a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) included (supports VSCode and GitHub Codespaces)\n* Later: [MCP server](https://www.anthropic.com/news/model-context-protocol) to connect Brave Search with Claude Desktop and other MCP clients\n\n## Usage Examples\n\n### Streamlit App\n\n\n\n[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)\n\n\n### Minimal Python Script:\n\n```python\nimport asyncio\nimport json\nimport os\n\nfrom dotenv import load_dotenv\n\nfrom brave_search_python_client import (\n BraveSearch,\n CountryCode,\n ImagesSearchRequest,\n LanguageCode,\n NewsSearchRequest,\n VideosSearchRequest,\n WebSearchRequest,\n)\n\n# Load .env file and get Brave Search API key from environment\nload_dotenv()\napi_key = os.getenv(\"BRAVE_SEARCH_API_KEY\")\nif not api_key:\n raise Exception(\"BRAVE_SEARCH_API_KEY not found in environment\")\n\n\nasync def search():\n \"\"\"Run various searches using the Brave Search Python Client (see https://brave-search-python-client.readthedocs.io/en/latest/reference_index.html)\"\"\"\n\n # Initialize the Brave Search Python client, using the API key from the environment\n bs = BraveSearch()\n\n # Perform a web search\n response = await bs.web(WebSearchRequest(q=\"jupyter\"))\n\n # Print results as JSON\n print(\"# Web search\")\n print(\"## JSON response\")\n print(json.dumps(response.model_dump(), indent=2))\n\n # Iterate over web hits and render links in markdown\n print(\"## Iterate and render\")\n for result in response.web.results if response.web else []:\n print(f\"[{result.title}]({result.url})\")\n\n # Advanced search with parameters\n response = await bs.web(\n WebSearchRequest(\n q=\"python programming\",\n country=CountryCode.DE,\n search_lang=LanguageCode.DE,\n )\n )\n print(\"# Advanced search results\")\n for result in response.web.results if response.web else []:\n print(f\"[{result.title}]({result.url})\")\n\n # Search and render images\n print(\"# Images\")\n response = await bs.images(ImagesSearchRequest(q=\"cute cats\"))\n for image in response.results if response.results else []:\n print(f\"\")\n\n # Search and render videos\n print(\"# Videos\")\n response = await bs.videos(VideosSearchRequest(q=\"singularity is close\"))\n for video in response.results if response.results else []:\n print(f\"\")\n\n # Search and render news\n print(\"# News\")\n response = await bs.news(NewsSearchRequest(q=\"AI\"))\n for item in response.results if response.results else []:\n print(f\"\")\n\n\n# Run the async search function\n# Alternatively use await search() from an async function\nasyncio.run(search())\n```\n\n[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_index.html#brave_search_python_client.BraveSearch)\n\n## Jupyter Notebook\n\n\n\n[Show notebook code](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/examples/jupyter.ipynb)\n\n\n## Command Line Interface (CLI)\n\n### Run with [uvx](https://docs.astral.sh/uv/guides/tools/)\n\nAdd Brave Search API key to the environment\n\n```shell\nexport BRAVE_SEARCH_API_KEY=YOUR_API_KEY\n```\n\nShow available commands:\n\n```shell\nuvx brave-search-python-client --help\n```\n\nSearch the web for \"hello world\":\n\n```shell\nuvx brave-search-python-client web \"hello world\"\n```\n\nShow options for web search\n\n```shell\nuvx brave-search-python-client web --help\n```\n\nSearch images:\n\n```shell\nuvx brave-search-python-client images \"hello world\"\n```\n\nShow options for image search\n\n```shell\nuvx brave-search-python-client images --help\n```\n\nSearch videos:\n\n```shell\nuvx brave-search-python-client videos \"hello world\"\n```\n\nShow options for videos search\n\n```shell\nuvx brave-search-python-client videos --help\n```\n\nSearch news:\n\n```shell\nuvx brave-search-python-client news \"hello world\"\n```\n\nShow options for news search\n\n```shell\nuvx brave-search-python-client news --help\n```\n\n### Run with Docker\n\nNote: Replace YOUR_BRAVE_SEARCH_API_KEY with your API key in the following examples.\n\nShow available commands:\n\n```bash\ndocker run helmuthva/brave-search-python-client --help\n```\n\nSearch the web:\n\n```bash\ndocker run --env BRAVE_SEARCH_API_KEY=YOUR_BRAVE_SEARCH_API_KEY helmuthva/brave-search-python-client web \"hello world\"\n```\n\nShow options for web search\n\n```bash\ndocker run helmuthva/brave-search-python-client web --help\n```\n\nSearch images:\n\n```bash\ndocker run --env BRAVE_SEARCH_API_KEY=YOUR_BRAVE_SEARCH_API_KEY helmuthva/brave-search-python-client images \"hello world\"\n```\n\nShow options for image search\n\n```bash\ndocker run helmuthva/brave-search-python-client images --help\n```\n\nSearch videos:\n\n```bash\ndocker run --env BRAVE_SEARCH_API_KEY=YOUR_BRAVE_SEARCH_API_KEY helmuthva/brave-search-python-client videos \"hello world\"\n```\n\nShow options for video search\n\n```bash\ndocker run helmuthva/brave-search-python-client videos --help\n```\n\nSearch news:\n\n```bash\ndocker run --env BRAVE_SEARCH_API_KEY=YOUR_BRAVE_SEARCH_API_KEY helmuthva/brave-search-python-client news \"hello world\"\n```\n\nShow options for news search\n\n```bash\ndocker run helmuthva/brave-search-python-client news --help\n```\n\n## Extra: MCP Server\n\nTK\n\n## Contributing\n\nPlease read our [Contributing Guidelines](https://brave-search-python-client.readthedocs.io/en/latest/contributing.html) for how to setup your development environment, and guidance for making pull requests.\n\n## Resources\n\n* [API](https://brave.com/search/api/)\n* [MCP Specification and SDKs](https://github.com/modelcontextprotocol)\n\n## Star History\n\n<a href=\"https://star-history.com/#helmut-hoffer-von-ankershoffen/brave-search-python-client&Date\">\n <picture>\n <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\" />\n <source media=\"(prefers-color-scheme: light)\" srcset=\"https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/brave-search-python-client&type=Date\" />\n <img alt=\"Star History Chart\" src=\"https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/brave-search-python-client&type=Date\" />\n </picture>\n</a>\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) [2024] [Helmut Hoffer von Ankershoffen (helmuthva@googlemail.com)] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "\ud83e\udd81 Brave Search Python Client supporting Web, Image, News and Video search.",
"version": "0.2.15",
"project_urls": {
"Changelog": "https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/releases",
"Documentation": "https://brave-search-python-client.readthedocs.io/",
"Homepage": "https://brave-search-python-client.readthedocs.io/",
"Issues": "https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/issues",
"Source": "https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client"
},
"split_keywords": [
"api",
" async",
" brave",
" brave-api",
" brave-search",
" bravesearch",
" bravesearchapi",
" codecov",
" docker",
" pydantic",
" python",
" ruff",
" search",
" sonarqube",
" typer",
" uv"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5c5731a54272a6dd3a6a90df37ca553563a52a53923a88821f25d3a4702b11f0",
"md5": "5d2e3fa2cd20ced52a62a57cef6efad8",
"sha256": "5e33b8e2c5e24af3391b7aafdce24c4ed2a8d0bc433e6b266b510d0422e5db68"
},
"downloads": -1,
"filename": "brave_search_python_client-0.2.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5d2e3fa2cd20ced52a62a57cef6efad8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 65897,
"upload_time": "2025-01-03T10:06:48",
"upload_time_iso_8601": "2025-01-03T10:06:48.002849Z",
"url": "https://files.pythonhosted.org/packages/5c/57/31a54272a6dd3a6a90df37ca553563a52a53923a88821f25d3a4702b11f0/brave_search_python_client-0.2.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c0b998842dc1b4b88b5abe79a7dbc0c34283e1992792ef9c2e7bf4a95faf78c3",
"md5": "2f0ff570ff6c6a02d264c6ef81b47b70",
"sha256": "eb7e490e9c8564d38f844c9bd273f9da14f04d4bc443cd5a4b3dfd2c9ddb5f4d"
},
"downloads": -1,
"filename": "brave_search_python_client-0.2.15.tar.gz",
"has_sig": false,
"md5_digest": "2f0ff570ff6c6a02d264c6ef81b47b70",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 37310320,
"upload_time": "2025-01-03T10:06:53",
"upload_time_iso_8601": "2025-01-03T10:06:53.402780Z",
"url": "https://files.pythonhosted.org/packages/c0/b9/98842dc1b4b88b5abe79a7dbc0c34283e1992792ef9c2e7bf4a95faf78c3/brave_search_python_client-0.2.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-03 10:06:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "helmut-hoffer-von-ankershoffen",
"github_project": "brave-search-python-client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "brave-search-python-client"
}
