Brave Search Python Client supporting Web, Image, News and Video search.
Use Cases:
Integrate into your Python code to help users find what they're looking for.
Add to your AI applications to give LLMs access to current web information.
Use the built-in CLI in shell scripts to get search results in JSON format.
Overview
Adding Brave Search Python Client to your project as a dependency is easy.
uv add brave-search-python-client # add dependency to your project
If you don't have uv installed follow
these instructions.
If you still prefer pip over the modern and fast package manager
uv, you can install the library like this:
pip install brave-search-python-client # add dependency to your project
Obtain your Brave Search API key by
signing up here - 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.
If you just want to try out the client without having to write code you can use
the integrated CLI:
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
and in the CLI:
# 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:
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
Operational Excellence
This project is designed with operational excellence in mind, using modern
Python tooling and practices. It includes:
"""
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 rich.console import Console
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")
ifnot api_key:
msg = "BRAVE_SEARCH_API_KEY not found in environment"raise ValueError(msg)
asyncdefsearch() -> None:
"""Run various searches using the Brave Search Python Client (see https://brave-search-python-client.readthedocs.io/en/latest/lib_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 markdownfor _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())
Note: Replace YOUR_BRAVE_SEARCH_API_KEY with your API key in the following
examples.
Show available commands:
docker run helmuthva/brave-search-python-client --help
Search the web:
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
docker run helmuthva/brave-search-python-client web --help
Search images:
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
docker run helmuthva/brave-search-python-client images --help
Search videos:
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
docker run helmuthva/brave-search-python-client videos --help
Search news:
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
docker run helmuthva/brave-search-python-client news --help
Or use docker compose
File .env is passed through
docker compose up
docker compose run brave-search-python-client --help
Further Reading
Inspect our security policy with detailed documentation of checks, tools and principles.
Check out the CLI reference with detailed documentation of all CLI commands and options.
Check out the library reference with detailed documentation of public classes and functions.
Check out the API reference with detailed documentation of all API operations and parameters.
Our release notes provide a complete log of recent improvements and changes.
In case you want to help us improve 🦁 Brave Search Python Client: The contribution guidelines explain how to setup your development environment and create pull requests.
We gratefully acknowledge the open source projects that this project builds upon. Thank you to all these wonderful contributors!
🦁 Brave Search Python Client supporting Web, Image, News and Video search.
We found that brave-search-python-client demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Socket’s Threat Research Team has uncovered 60 npm packages using post-install scripts to silently exfiltrate hostnames, IP addresses, DNS servers, and user directories to a Discord-controlled endpoint.