brave-search-python-client 0.0.7

🦁 Brave Search Python Client supporting Web, Image, News and Video search.

[PRE-ALPHA] 🦁 Brave Search Python Client

⚠️ WARNING: This project is currently in pre-alpha phase, i.e. partly functional. Feel free to already watch or star the repository to stay updated on its progress.

Overview

Brave Search Python Client supporting Web, Image, News and Video search.

• Modern async Python client for Web, Image, Video and News search powered by Brave Search
• Thorough validation of both requests and responess (powered by Pydantic)
• 100% test coverage (unit and E2E tests)
• 100% compliance modern linting and formatting standards (powered by Ruff)
• 100% up-to-date dependencies through automated updates (reported on Codecov)
• A-grade code quality ratings in security, maintainability, and reliability (verified by SonarQube)
• 1-liner for installation and execution of command line interface (CLI) via uv(x) or Docker
• Setup for developing in devcontainer included (supports VSCode and GitHub Codespaces)
• MCP Server to connect Brave Search with Claude Desktop and other MCP clients

Python Client

Basic Web Search

from brave_search import BraveSearch

# Initialize client with your API key
client = BraveSearch(api_key="YOUR-API-KEY")

# Perform a web search
results = client.web_search("brave browser")

# Access search results
for result in results.web:
    print(f"Title: {result.title}")
    print(f"URL: {result.url}")
    print(f"Description: {result.description}")

Image Search

# Search for images
image_results = client.image_search("cute cats")

for image in image_results.images:
    print(f"Image URL: {image.url}")
    print(f"Source: {image.source}")

News Search

# Search for news articles
news_results = client.news_search("technology")

for article in news_results.news:
    print(f"Title: {article.title}")
    print(f"Published: {article.published}")

Video Search

# Search for videos
video_results = client.video_search("python tutorials")

for video in video_results.videos:
    print(f"Title: {video.title}")
    print(f"URL: {video.url}")

Using Search Parameters

# Advanced search with parameters
results = client.web_search(
    "python programming",
    country="US",
    search_lang="en",
)

Command Line Interface (CLI)

Run with uvx

Create .env file with API key:

./setup--dot-env YOUR_BRAVE_SEARCH_API_KEY

Show available commands:

```shell
uvx brave-search-python-client --help

Execute web search:

uvx brave-search-python-client web "hello world"

Show options for web search

uvx brave-search-python-client web --help

Execute image search:

uvx brave-search-python-client image "hello world"

Show options for image search

uvx brave-search-python-client image --help

Execute videos search:

uvx brave-search-python-client video "hello world"

Show options for videos search

uvx brave-search-python-client video --help

Execute news search:

uvx brave-search-python-client video "hello world"

Run with Docker

Show options for news search

docker run helmuthva/brave-search-python-client news --help

Docker

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

Execute web search:

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

Execute image search:

docker run --env BRAVE_SEARCH_API_KEY=YOUR_BRAVE_SEARCH_API_KEY helmuthva/brave-search-python-client image "hello world"

Show options for image search

docker run helmuthva/brave-search-python-client image --help

Execute videos search:

docker run --env BRAVE_SEARCH_API_KEY=YOUR_BRAVE_SEARCH_API_KEY helmuthva/brave-search-python-client video "hello world"

Show options for videos search

docker run helmuthva/brave-search-python-client video --help

Execute news search:

docker run --env BRAVE_SEARCH_API_KEY=YOUR_BRAVE_SEARCH_API_KEY helmuthva/brave-search-python-client video "hello world"

Show options for news search

docker run helmuthva/brave-search-python-client news --help

Extra: MCP Server

TK

Contributing

Please read our Contributing Guidelines for how to setup your development environment, and guidance for making pull requests.

Resources

• API
• MCP Specification and SDKs

Star History