| Name | brave-search-python-client JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | None |
| Summary | 🦁 Brave Search Python Client supporting Web, Image, News and Video search. |
| upload_time | 2025-03-16 21:38:12 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4.0,>=3.11 |
| license | MIT License Copyright (c) [2025] [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 |
act
api
brave
brave-api
brave-search
brave-search-api
brave-search-python-client
bravesearch
bravesearchapi
codecov
copier
cyclonedx
detect-secrets
devcontainer
docker
git-cliff
jupyter
marimo
mypy
nox
oe-python-template
pip-audit
pip-licenses
pre-commit
pydantic
pypi
pytest
python
readthedocs
ruff
sonarcloud
sonarqube
sphinx
streamlit
typer
uv
web-search
websearch
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[//]: # (README.md generated from docs/partials/README_*.md)
# 🦁 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/en/latest/)
[](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://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/security/code-scanning)
[](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/security/dependabot)
[](https://renovatebot.com/)
[](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-client/blob/main/noxfile.py)
[](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/releases)
[](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/commits/main/)
[](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/oe-python-template)
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client)
[](https://github.com/codespaces/new/helmut-hoffer-von-ankershoffen/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)
-->
> [!TIP]
> 📚 [Online documentation](https://brave-search-python-client.readthedocs.io/en/latest/) - 📖 [PDF Manual](https://brave-search-python-client.readthedocs.io/_/downloads/en/latest/pdf/)
> [!NOTE]
> 🧠 This project was scaffolded using the template [oe-python-template](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template) with [copier](https://copier.readthedocs.io/).
---
Brave Search Python Client supporting Web, Image, News and Video search.
Use Cases:
1. Fast and easy to use project setup
2. Consistent update of already scaffolded projects to benefit from new and
improved features.
3. Dummy CLI application and service demonstrating example usage of the
generated directory structure and build pipeline
## Scaffolding
**Step 1**: Install uv package manager and copier
```shell
if [[ "$OSTYPE" == "darwin"* ]]; then # Install dependencies for macOS X
if ! command -v brew &> /dev/null; then ## Install Homebrew if not present
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
fi
elif [[ "$OSTYPE" == "linux-gnu"* ]]; then # Install dependencies for Linux
sudo apt-get update -y && sudo apt-get install curl -y # Install curl
fi
if ! command -v uvx &> /dev/null; then # Install uv package manager if not present
curl -LsSf https://astral.sh/uv/install.sh | sh
source $HOME/.local/bin/env
fi
uv tool install copier # Install copier as global tool
```
**Step 2**: Now create an empty repository on GitHubm, clone to your local
machine, and change into it's directory.
**Step 3**: Scaffold the project
```shell
copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
```
**Step 4**: Setup the local environment
```shell
uv run nox -s setup_dev
```
**Step 5**: Perform initial commit and push
```shell
git add .
git commit -m "feat: Initial commit"
git push
```
Visit your GitHub repository and check the Actions tab. The CI workflow should
fail at the SonarQube step, as this external service is not yet configured for
our new repository.
**Step 6**: Follow the [instructions](SERVICE_CONNECTIONS.md) to wire up
external services such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io,
GHCR.io and Streamlit Community Cloud.
**Step 7**: Release the first versions
```shell
./bump
```
Notes:
- You can remove this section post having successfully scafolded your project.
- The following sections refer to the dummy application and service provided by
this template. Use them as inspiration and adapt them to your own project.
## Overview
Adding Brave Search Python Client to your project as a dependency is easy.
```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
```
Executing the command line interface (CLI) in an isolated Python environment is
just as easy:
```shell
uvx brave-search-python-client hello-world # prints "Hello, world! [..]"
uvx brave-search-python-client serve # serves webservice API
uvx brave-search-python-client serve --port=4711 # serves webservice API on port 4711
```
Notes:
- The API is versioned, mounted at `/api/v1` resp. `/api/v2`
- While serving the webservice API go to
[http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world)
to see the respons of the `hello-world` operation.
- Interactive documentation is provided at
[http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)
The CLI provides extensive help:
```shell
uvx brave-search-python-client --help # all CLI commands
uvx brave-search-python-client hello-world --help # help for specific command
uvx brave-search-python-client echo --help
uvx brave-search-python-client openapi --help
uvx brave-search-python-client serve --help
```
## Operational Excellence
This project is designed with operational excellence in mind, using modern
Python tooling and practices. It includes:
- Various examples demonstrating usage:
- [Simple Python script](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/examples/script.py)
- [Streamlit web application](https://brave-search-python-client.streamlit.app/)
deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
- [Jupyter](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/examples/notebook.ipynb)
and
[Marimo](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/examples/notebook.py)
notebook
- [Complete reference documentation](https://brave-search-python-client.readthedocs.io/en/latest/reference.html)
on Read the Docs
- [Transparent 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
[multiple python versions](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/))
- Compliant with modern linting and formatting standards (powered by
[Ruff](https://github.com/astral-sh/ruff))
- Up-to-date dependencies (monitored by
[Renovate](https://github.com/renovatebot/renovate) and
[GitHub Dependabot](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/security/dependabot))
- [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 low technical debt and
codesmell (verified by SonarQube)
- Additional code security checks using
[GitHub CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/security/code-scanning)
- [Security Policy](SECURITY.md)
- [License](LICENSE) compliant with the Open Source Initiative (OSI)
- 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)
## Usage Examples
The following examples run from source. Clone this repository first using
`git clone git@github.com:helmut-hoffer-von-ankershoffen/brave-search-python-client.git`.
### Minimal Python Script:
```python
"""Example script demonstrating the usage of the service provided by Brave Search Python Client."""
from dotenv import load_dotenv
from rich.console import Console
from brave_search_python_client import Service
console = Console()
load_dotenv()
message = Service.get_hello_world()
console.print(f"[blue]{message}[/blue]")
```
[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)
### Streamlit App
Serve the functionality provided by Brave Search Python Client in the web by
easily integrating the service into a Streamlit application.
[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)
... or serve the app locally
```shell
uv sync --all-extras # Install streamlit dependency part of the examples extra, see pyproject.toml
uv run streamlit run examples/streamlit.py # Serve on localhost:8501, opens browser
```
## Notebooks
### Jupyter
[Show the Jupyter code](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/examples/notebook.ipynb)
... or run within VSCode
```shell
uv sync --all-extras # Install dependencies required for examples such as Juypyter kernel, see pyproject.toml
```
Install the
[Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
Click on `examples/notebook.ipynb` in VSCode and run it.
### Marimo
[Show the marimo code](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/examples/notebook.py)
Execute the notebook as a WASM based web app
```shell
uv sync --all-extras # Install ipykernel dependency part of the examples extra, see pyproject.toml
uv run marimo run examples/notebook.py --watch # Serve on localhost:2718, opens browser
```
or edit interactively in your browser
```shell
uv sync --all-extras # Install ipykernel dependency part of the examples extra, see pyproject.toml
uv run marimo edit examples/notebook.py --watch # Edit on localhost:2718, opens browser
```
... or edit interactively within VSCode
Install the
[Marimo extension for VSCode](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo)
Click on `examples/notebook.py` in VSCode and click on the caret next to the Run
icon above the code (looks like a pencil) > "Start in marimo editor" (edit).
## Command Line Interface (CLI)
### Run with [uvx](https://docs.astral.sh/uv/guides/tools/)
Show available commands:
```shell
uvx brave-search-python-client --help
```
Execute commands:
```shell
uvx brave-search-python-client hello-world
uvx brave-search-python-client echo --help
uvx brave-search-python-client echo "Lorem"
uvx brave-search-python-client echo "Lorem" --json
uvx brave-search-python-client openapi
uvx brave-search-python-client openapi --output-format=json
uvx brave-search-python-client serve
```
### Environment
The service loads environment variables including support for .env files.
```shell
cp .env.example .env # copy example file
echo "THE_VAR=MY_VALUE" > .env # overwrite with your values
```
Now run the usage examples again.
### Run with Docker
You can as well run the CLI within Docker.
```shell
docker run helmuthva/brave-search-python-client --help
docker run helmuthva/brave-search-python-client hello-world
docker run helmuthva/brave-search-python-client echo --help
docker run helmuthva/brave-search-python-client echo "Lorem"
docker run helmuthva/brave-search-python-client echo "Lorem" --json
docker run helmuthva/brave-search-python-client openapi
docker run helmuthva/brave-search-python-client openapi --output-format=json
docker run helmuthva/brave-search-python-client serve
```
Execute command:
```shell
docker run --env THE_VAR=MY_VALUE helmuthva/brave-search-python-client echo "Lorem Ipsum"
```
Or use docker compose
The .env is passed through from the host to the Docker container.
```shell
docker compose run brave-search-python-client --help
docker compose run brave-search-python-client hello-world
docker compose run brave-search-python-client echo --help
docker compose run brave-search-python-client echo "Lorem"
docker compose run brave-search-python-client echo "Lorem" --json
docker compose run brave-search-python-client openapi
docker compose run brave-search-python-client openapi --output-format=json
docker compose up
curl http://127.0.0.1:8000/api/v1/hello-world
curl http://127.0.0.1:8000/api/v1/docs
curl http://127.0.0.1:8000/api/v2/hello-world
curl http://127.0.0.1:8000/api/v2/docs
```
## Extra: Lorem Ipsum
Dolor sit amet, consectetur adipiscing elit. Donec a diam lectus. Sed sit amet
ipsum mauris. Maecenas congue ligula ac quam.
## 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 🦁 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">
<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": "act, api, brave, brave-api, brave-search, brave-search-api, brave-search-python-client, bravesearch, bravesearchapi, codecov, copier, cyclonedx, detect-secrets, devcontainer, docker, git-cliff, jupyter, marimo, mypy, nox, oe-python-template, pip-audit, pip-licenses, pre-commit, pydantic, pypi, pytest, python, readthedocs, ruff, sonarcloud, sonarqube, sphinx, streamlit, typer, uv, web-search, websearch",
"author": null,
"author_email": "Helmut Hoffer von Ankershoffen <helmuthva@googlemail.com>",
"download_url": "https://files.pythonhosted.org/packages/8f/af/1625ef53431f314d853751e3f4978c96ecd61d7126d88934a74b4e60f69d/brave_search_python_client-0.4.0.tar.gz",
"platform": null,
"description": "\n[//]: # (README.md generated from docs/partials/README_*.md)\n\n# \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/en/latest/)\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://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/security/code-scanning)\n[](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/security/dependabot)\n[](https://renovatebot.com/)\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-client/blob/main/noxfile.py)\n[](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/releases)\n[](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/commits/main/)\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[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)\n[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client)\n[](https://github.com/codespaces/new/helmut-hoffer-von-ankershoffen/brave-search-python-client)\n\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\n> [!TIP]\n> \ud83d\udcda [Online documentation](https://brave-search-python-client.readthedocs.io/en/latest/) - \ud83d\udcd6 [PDF Manual](https://brave-search-python-client.readthedocs.io/_/downloads/en/latest/pdf/)\n\n> [!NOTE]\n> \ud83e\udde0 This project was scaffolded using the template [oe-python-template](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template) with [copier](https://copier.readthedocs.io/).\n\n---\n\n\nBrave Search Python Client supporting Web, Image, News and Video search.\n\nUse Cases:\n\n1. Fast and easy to use project setup\n2. Consistent update of already scaffolded projects to benefit from new and\n improved features.\n3. Dummy CLI application and service demonstrating example usage of the\n generated directory structure and build pipeline\n\n## Scaffolding\n\n**Step 1**: Install uv package manager and copier\n\n```shell\nif [[ \"$OSTYPE\" == \"darwin\"* ]]; then # Install dependencies for macOS X\n if ! command -v brew &> /dev/null; then ## Install Homebrew if not present\n /bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)\"\n fi\nelif [[ \"$OSTYPE\" == \"linux-gnu\"* ]]; then # Install dependencies for Linux\n sudo apt-get update -y && sudo apt-get install curl -y # Install curl\nfi\nif ! command -v uvx &> /dev/null; then # Install uv package manager if not present\n curl -LsSf https://astral.sh/uv/install.sh | sh\n source $HOME/.local/bin/env\nfi\nuv tool install copier # Install copier as global tool\n```\n\n**Step 2**: Now create an empty repository on GitHubm, clone to your local\nmachine, and change into it's directory.\n\n**Step 3**: Scaffold the project\n\n```shell\ncopier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .\n```\n\n**Step 4**: Setup the local environment\n\n```shell\nuv run nox -s setup_dev\n```\n\n**Step 5**: Perform initial commit and push\n\n```shell\ngit add .\ngit commit -m \"feat: Initial commit\"\ngit push\n```\n\nVisit your GitHub repository and check the Actions tab. The CI workflow should\nfail at the SonarQube step, as this external service is not yet configured for\nour new repository.\n\n**Step 6**: Follow the [instructions](SERVICE_CONNECTIONS.md) to wire up\nexternal services such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io,\nGHCR.io and Streamlit Community Cloud.\n\n**Step 7**: Release the first versions\n\n```shell\n./bump\n```\n\nNotes:\n\n- You can remove this section post having successfully scafolded your project.\n- The following sections refer to the dummy application and service provided by\n this template. Use them as inspiration and adapt them to your own project.\n\n## Overview\n\nAdding Brave Search Python Client to your project as a dependency is easy.\n\n```shell\nuv add brave-search-python-client # add dependency to your project\n```\n\nIf you don't have uv installed follow\n[these instructions](https://docs.astral.sh/uv/getting-started/installation/).\nIf you still prefer pip over the modern and fast package manager\n[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\nExecuting the command line interface (CLI) in an isolated Python environment is\njust as easy:\n\n```shell\nuvx brave-search-python-client hello-world # prints \"Hello, world! [..]\"\nuvx brave-search-python-client serve # serves webservice API\nuvx brave-search-python-client serve --port=4711 # serves webservice API on port 4711\n```\n\nNotes:\n\n- The API is versioned, mounted at `/api/v1` resp. `/api/v2`\n- While serving the webservice API go to\n [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world)\n to see the respons of the `hello-world` operation.\n- Interactive documentation is provided at\n [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)\n\nThe CLI provides extensive help:\n\n```shell\nuvx brave-search-python-client --help # all CLI commands\nuvx brave-search-python-client hello-world --help # help for specific command\nuvx brave-search-python-client echo --help\nuvx brave-search-python-client openapi --help\nuvx brave-search-python-client serve --help\n```\n\n## Operational Excellence\n\nThis project is designed with operational excellence in mind, using modern\nPython tooling and practices. It includes:\n\n- Various examples demonstrating usage:\n - [Simple Python script](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/examples/script.py)\n - [Streamlit web application](https://brave-search-python-client.streamlit.app/)\n deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)\n - [Jupyter](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/examples/notebook.ipynb)\n and\n [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/examples/notebook.py)\n notebook\n- [Complete reference documentation](https://brave-search-python-client.readthedocs.io/en/latest/reference.html)\n on Read the Docs\n- [Transparent test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/brave-search-python-client)\n including unit and E2E tests (reported on Codecov)\n- Matrix tested with\n [multiple python versions](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/noxfile.py)\n to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))\n- Compliant with modern linting and formatting standards (powered by\n [Ruff](https://github.com/astral-sh/ruff))\n- Up-to-date dependencies (monitored by\n [Renovate](https://github.com/renovatebot/renovate) and\n [GitHub Dependabot](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/security/dependabot))\n- [A-grade code quality](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_brave-search-python-client)\n in security, maintainability, and reliability with low technical debt and\n codesmell (verified by SonarQube)\n- Additional code security checks using\n [GitHub CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/security/code-scanning)\n- [Security Policy](SECURITY.md)\n- [License](LICENSE) compliant with the Open Source Initiative (OSI)\n- 1-liner for installation and execution of command line interface (CLI) via\n [uv(x)](https://github.com/astral-sh/uv) or\n [Docker](https://hub.docker.com/r/helmuthva/brave-search-python-client/tags)\n- Setup for developing inside a\n [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers)\n included (supports VSCode and GitHub Codespaces)\n\n## Usage Examples\n\nThe following examples run from source. Clone this repository first using\n`git clone git@github.com:helmut-hoffer-von-ankershoffen/brave-search-python-client.git`.\n\n### Minimal Python Script:\n\n```python\n\"\"\"Example script demonstrating the usage of the service provided by Brave Search Python Client.\"\"\"\n\nfrom dotenv import load_dotenv\nfrom rich.console import Console\n\nfrom brave_search_python_client import Service\n\nconsole = Console()\n\nload_dotenv()\n\nmessage = Service.get_hello_world()\nconsole.print(f\"[blue]{message}[/blue]\")\n```\n\n[Show script code](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/examples/script.py) -\n[Read the reference documentation](https://brave-search-python-client.readthedocs.io/en/latest/reference.html)\n\n### Streamlit App\n\nServe the functionality provided by Brave Search Python Client in the web by\neasily integrating the service into a Streamlit application.\n\n[Try it out!](https://brave-search-python-client.streamlit.app) -\n[Show the code](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/examples/streamlit.py)\n\n... or serve the app locally\n\n```shell\nuv sync --all-extras # Install streamlit dependency part of the examples extra, see pyproject.toml\nuv run streamlit run examples/streamlit.py # Serve on localhost:8501, opens browser\n```\n\n## Notebooks\n\n### Jupyter\n\n[Show the Jupyter code](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/examples/notebook.ipynb)\n\n... or run within VSCode\n\n```shell\nuv sync --all-extras # Install dependencies required for examples such as Juypyter kernel, see pyproject.toml\n```\n\nInstall the\n[Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)\n\nClick on `examples/notebook.ipynb` in VSCode and run it.\n\n### Marimo\n\n[Show the marimo code](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/blob/main/examples/notebook.py)\n\nExecute the notebook as a WASM based web app\n\n```shell\nuv sync --all-extras # Install ipykernel dependency part of the examples extra, see pyproject.toml\nuv run marimo run examples/notebook.py --watch # Serve on localhost:2718, opens browser\n```\n\nor edit interactively in your browser\n\n```shell\nuv sync --all-extras # Install ipykernel dependency part of the examples extra, see pyproject.toml\nuv run marimo edit examples/notebook.py --watch # Edit on localhost:2718, opens browser\n```\n\n... or edit interactively within VSCode\n\nInstall the\n[Marimo extension for VSCode](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo)\n\nClick on `examples/notebook.py` in VSCode and click on the caret next to the Run\nicon above the code (looks like a pencil) > \"Start in marimo editor\" (edit).\n\n## Command Line Interface (CLI)\n\n### Run with [uvx](https://docs.astral.sh/uv/guides/tools/)\n\nShow available commands:\n\n```shell\nuvx brave-search-python-client --help\n```\n\nExecute commands:\n\n```shell\nuvx brave-search-python-client hello-world\nuvx brave-search-python-client echo --help\nuvx brave-search-python-client echo \"Lorem\"\nuvx brave-search-python-client echo \"Lorem\" --json\nuvx brave-search-python-client openapi\nuvx brave-search-python-client openapi --output-format=json\nuvx brave-search-python-client serve\n```\n\n### Environment\n\nThe service loads environment variables including support for .env files.\n\n```shell\ncp .env.example .env # copy example file\necho \"THE_VAR=MY_VALUE\" > .env # overwrite with your values\n```\n\nNow run the usage examples again.\n\n### Run with Docker\n\nYou can as well run the CLI within Docker.\n\n```shell\ndocker run helmuthva/brave-search-python-client --help\ndocker run helmuthva/brave-search-python-client hello-world\ndocker run helmuthva/brave-search-python-client echo --help\ndocker run helmuthva/brave-search-python-client echo \"Lorem\"\ndocker run helmuthva/brave-search-python-client echo \"Lorem\" --json\ndocker run helmuthva/brave-search-python-client openapi\ndocker run helmuthva/brave-search-python-client openapi --output-format=json\ndocker run helmuthva/brave-search-python-client serve\n```\n\nExecute command:\n\n```shell\ndocker run --env THE_VAR=MY_VALUE helmuthva/brave-search-python-client echo \"Lorem Ipsum\"\n```\n\nOr use docker compose\n\nThe .env is passed through from the host to the Docker container.\n\n```shell\ndocker compose run brave-search-python-client --help\ndocker compose run brave-search-python-client hello-world\ndocker compose run brave-search-python-client echo --help\ndocker compose run brave-search-python-client echo \"Lorem\"\ndocker compose run brave-search-python-client echo \"Lorem\" --json\ndocker compose run brave-search-python-client openapi\ndocker compose run brave-search-python-client openapi --output-format=json\ndocker compose up\ncurl http://127.0.0.1:8000/api/v1/hello-world\ncurl http://127.0.0.1:8000/api/v1/docs\ncurl http://127.0.0.1:8000/api/v2/hello-world\ncurl http://127.0.0.1:8000/api/v2/docs\n```\n\n## Extra: Lorem Ipsum\n\nDolor sit amet, consectetur adipiscing elit. Donec a diam lectus. Sed sit amet\nipsum mauris. Maecenas congue ligula ac quam.\n\n\n## Further Reading\n\n* Check out the [reference](https://brave-search-python-client.readthedocs.io/en/latest/reference.html) with detailed documentation of public classes and functions.\n* Our [release notes](https://brave-search-python-client.readthedocs.io/en/latest/release-notes.html) provide a complete log of recent improvements and changes.\n* In case you want to help us improve \ud83e\udd81 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.\n\n## Star History\n\n<a href=\"https://star-history.com/#helmut-hoffer-von-ankershoffen/brave-search-python-client\">\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) [2025] [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.4.0",
"project_urls": {
"Changelog": "https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/releases",
"Documentation": "https://brave-search-python-client.readthedocs.io/en/latest/",
"Homepage": "https://brave-search-python-client.readthedocs.io/en/latest/",
"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": [
"act",
" api",
" brave",
" brave-api",
" brave-search",
" brave-search-api",
" brave-search-python-client",
" bravesearch",
" bravesearchapi",
" codecov",
" copier",
" cyclonedx",
" detect-secrets",
" devcontainer",
" docker",
" git-cliff",
" jupyter",
" marimo",
" mypy",
" nox",
" oe-python-template",
" pip-audit",
" pip-licenses",
" pre-commit",
" pydantic",
" pypi",
" pytest",
" python",
" readthedocs",
" ruff",
" sonarcloud",
" sonarqube",
" sphinx",
" streamlit",
" typer",
" uv",
" web-search",
" websearch"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3a10acef8b4750f79d371102b743634b66e09c802413797efddc2b9a0b3733ae",
"md5": "24ba674366b6212b224f5bbd10968a96",
"sha256": "320664ad363ab845b83a302295fae502263b1283c3347e0528f91132b486df16"
},
"downloads": -1,
"filename": "brave_search_python_client-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "24ba674366b6212b224f5bbd10968a96",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 68625,
"upload_time": "2025-03-16T21:38:09",
"upload_time_iso_8601": "2025-03-16T21:38:09.561391Z",
"url": "https://files.pythonhosted.org/packages/3a/10/acef8b4750f79d371102b743634b66e09c802413797efddc2b9a0b3733ae/brave_search_python_client-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8faf1625ef53431f314d853751e3f4978c96ecd61d7126d88934a74b4e60f69d",
"md5": "744cbce02757a79adf9b579caa95ebcb",
"sha256": "2083f47eb6f97ce390d22d70103eea3acb2b0c19171c095e97772e0e07a50790"
},
"downloads": -1,
"filename": "brave_search_python_client-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "744cbce02757a79adf9b579caa95ebcb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 37359293,
"upload_time": "2025-03-16T21:38:12",
"upload_time_iso_8601": "2025-03-16T21:38:12.415930Z",
"url": "https://files.pythonhosted.org/packages/8f/af/1625ef53431f314d853751e3f4978c96ecd61d7126d88934a74b4e60f69d/brave_search_python_client-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-16 21:38:12",
"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"
}
