Skip to main content

No project description provided

Project description

official project PyPI version License

Databao CLI

A command-line interface tool for working with Databao Agent and Databao Context Engine

WebsiteQuickstartDocsDiscord


Installation

Databao CLI is available on PyPI and can be installed with uv, pip, or another package manager.

Using uv

uv add databao

Using pip

pip install databao

Quickstart

  1. Create a project directory and navigate to it:

    mkdir databao-project && cd databao-project
    

    [!TIP] Databao is not terminal-only. If you prefer the web interface, run databao app in your project directory.

  2. Initialize the project:

    databao init
    
  3. When prompted, agree to configure a domain – a dedicated space where data context, context, and agent chats live.

    Then follow the prompts to add one or several data sources.

  4. Build context:

    databao build
    
  5. Pass your API key as an environment variable:

    # OpenAI or OpenAI-compatible APIs
    export OPENAI_API_KEY=<your-key>
    
    # Anthropic Claude
    export ANTHROPIC_API_KEY=<your-key>
    
  6. Run the Databao Agent:

    databao ask
    
  7. Ask questions about your data:

    # Example questions:
    What is our refund rate by month?
    What is our 90-day repeat purchase rate
    

For more details about commands, supported data sources, and configuration options, visit the docs.

Releasing

# Tag and push a specific version (CI publishes to PyPI)
make release VERSION=0.3.0

# Bump the patch version automatically (e.g. 0.3.0 -> 0.3.1)
make patch-release

# Bump the minor version automatically (e.g. 0.3.1 -> 0.4.0)
make minor-release

# Bump the major version automatically (e.g. 0.4.0 -> 1.0.0)
make major-release

# Trigger a dev release via GitHub Actions
make dev-release

Contributing

We love contributions! Here’s how you can help:

  • Star this repo — it helps others find us!
  • 🐛 Found a bug? Open an issue
  • 💡 Have an idea? We’re all ears — create a feature request
  • 👍 Upvote issues you care about — helps us prioritize
  • 🔧 Submit a PR
  • 📝 Improve docs — typos, examples, tutorials — everything helps!

New to open source? No worries! We’re friendly and happy to help you get started.

License

Apache 2.0 — use it however you want.

See the LICENSE file for details.


Like Databao? Give us a ⭐! It will help to distribute the technology.

WebsiteDocsDiscord

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

databao-0.3.6.tar.gz (677.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

databao-0.3.6-py3-none-any.whl (161.1 kB view details)

Uploaded Python 3

File details

Details for the file databao-0.3.6.tar.gz.

File metadata

  • Download URL: databao-0.3.6.tar.gz
  • Upload date:
  • Size: 677.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.5 {"installer":{"name":"uv","version":"0.10.5","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}

File hashes

Hashes for databao-0.3.6.tar.gz
Algorithm Hash digest
SHA256 50b49e89029b05cbe0ed58f1cc75929b3052f47507d7679a999a6539d8fce567
MD5 8539216b803d173d7ab69748ff20ce42
BLAKE2b-256 a7fcfabdb46870bd648b6d66bc46af7325f344b3c79c33fb62ae85e0bee02169

See more details on using hashes here.

File details

Details for the file databao-0.3.6-py3-none-any.whl.

File metadata

  • Download URL: databao-0.3.6-py3-none-any.whl
  • Upload date:
  • Size: 161.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.5 {"installer":{"name":"uv","version":"0.10.5","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}

File hashes

Hashes for databao-0.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 806259245f6730166c4341cc509c53a67ed318fb509c1b3098448d1329686ccd
MD5 9b79c60127d292a9e9b81f358139da05
BLAKE2b-256 79d2a665fc669366b8ce018bfd93652cdbf034a10b08f45ea0507e32674404f0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page