● Getting started

Installation

Requirements

  • Python 3.10 or higher
  • pip or uv

Install

pip install dbsprout

Or with uv:

uv add dbsprout

Optional Extras

The core install is dependency-light — everything beyond schema parsing and heuristic generation is an opt-in extra:

pip install dbsprout[db]       # SQLAlchemy + drivers (PostgreSQL, MySQL)
pip install dbsprout[mssql]    # SQL Server support (pyodbc)
pip install dbsprout[llm]      # Embedded LLM (llama-cpp-python + Qwen 2.5-1.5B)
pip install dbsprout[cloud]    # Cloud LLM providers (LiteLLM + Instructor)
pip install dbsprout[privacy]  # PII redaction (Presidio)
pip install dbsprout[dev]      # Development tools (pytest, ruff, mypy)
pip install dbsprout[docs]     # Documentation site tooling (mkdocs-material)

Shells that glob [] (zsh, bash) need the target quoted: pip install "dbsprout[llm]".

Verify Installation

dbsprout --help

Next Steps

Continue to the Quick Start guide to generate your first seed data.