Skip to main content

bub-web-search

Provider-selectable web tools for bub, covering two capabilities:

  • web.search: search the web, backed by one search provider
  • web.read: read a webpage as clean markdown, backed by one reader provider

Each capability has its own provider dimension, so they can be mixed freely (e.g. SearXNG for search, Jina for reading).

Search providers

Set BUB_SEARCH_PROVIDER (or provider in the web-search: config section) to enable exactly one search provider:

  • ollama
  • searxng
  • jina

If the provider is unset it is inferred from which provider-specific configuration is present. If nothing resolves, web.search is not registered.

Reader providers

There is no explicit reader selector: web.read is enabled by configuring a reader-capable platform. Currently that means a jina_api_key (Jina Reader); without one, web.read is not registered. A selector field will only be introduced once more than one reader platform exists.

Installation

bub install bub-web-search

Run bub onboard to select a provider and write its configuration interactively.

Ollama

Required:

  • BUB_SEARCH_PROVIDER=ollama
  • BUB_SEARCH_OLLAMA_API_KEY

Optional:

  • BUB_SEARCH_OLLAMA_API_BASE
    • Default: https://ollama.com/api

The web.search tool accepts query and max_results.

Jina

Required:

  • BUB_SEARCH_PROVIDER=jina for search; BUB_SEARCH_JINA_API_KEY alone already enables the web.read reader
  • BUB_SEARCH_JINA_API_KEY

Optional:

  • BUB_SEARCH_JINA_SEARCH_BASE
    • Default: https://s.jina.ai
  • BUB_SEARCH_JINA_READER_BASE
    • Default: https://r.jina.ai
  • BUB_SEARCH_JINA_TIMEOUT_SECONDS
    • Default: 30

The web.search tool accepts query. The web.read tool accepts url and returns the page content as markdown.

All settings can also be written to the web-search: section of the Bub config file, e.g.:

web-search:
  provider: jina
  jina_api_key: jina_...

or mixing platforms per capability (SearXNG searches, Jina reads):

web-search:
  provider: searxng
  searxng_base_url: https://searx.example.com
  jina_api_key: jina_...

SearXNG

Required:

  • BUB_SEARCH_PROVIDER=searxng
  • BUB_SEARCH_SEARXNG_BASE_URL

Optional:

  • BUB_SEARCH_SEARXNG_TIMEOUT_SECONDS
    • Default: 10
  • BUB_SEARCH_SEARXNG_DEFAULT_LANGUAGE
  • BUB_SEARCH_SEARXNG_DEFAULT_SAFE_SEARCH
    • 0 off, 1 moderate, 2 strict
    • Default: 1
  • BUB_SEARCH_SEARXNG_USER_AGENT
    • Default: bub-web-search/1.0
  • BUB_SEARCH_SEARXNG_AUTH_HEADER
  • BUB_SEARCH_SEARXNG_AUTH_VALUE

The searxng.search tool accepts:

  • query
  • max_results
  • categories
  • engines
  • language
  • time_range
  • safe_search

The SearXNG instance must allow JSON responses from its /search endpoint.

Replace the package with bub-web-search, set BUB_SEARCH_PROVIDER=searxng, and rename the environment variables:

  • BUB_SEARXNG_SEARCH_BASE_URL to BUB_SEARCH_SEARXNG_BASE_URL
  • other BUB_SEARXNG_SEARCH_* variables to BUB_SEARCH_SEARXNG_*

Metadata

Release files for bub-web-search 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bub-web-search 0.1.0
File Size Uploaded Provenance
bub_web_search-0.1.0.tar.gz 8.2 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for bub-web-search 0.1.0
File Interpreter ABI Platform
bub_web_search-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 19.7 kB

Release files / bub_web_search-0.1.0.tar.gz

Download URL bub_web_search-0.1.0.tar.gz
Size 8.2 kB
Tags Source
SHA-256 checksum
How to use checksums
09338d22141b3d761a3730837897d7b5cb609d4c2bf0990d432bba87bfa97730
BLAKE2b-256 checksum
How to use checksums
503cf3dca203126aa0e8b4b1abc48d4e8d6ae2b3fff36ddd1c6ea46ced51d74f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.21 {"installer":{"name":"uv","version":"0.12.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / bub_web_search-0.1.0-py3-none-any.whl

Download URL bub_web_search-0.1.0-py3-none-any.whl
Size 11.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ae499960dbba94221cd8bbe540c3a8bae843eba56360653d65ec6f180ab6e79d
BLAKE2b-256 checksum
How to use checksums
d60f78684f5b673a4b101136eea87646affa2deea4ce40cc0047c17636f949ad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.21 {"installer":{"name":"uv","version":"0.12.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for bub-web-search 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page