Skip to content

Installation

Use this page when you want a clean local install and a quick smoke test. For connector-specific setup, start here and then follow the matching connector guide.

Requirements

Requirement Supported default
Python 3.11, 3.12
Package manager pip, uv, or any PEP 517 compatible installer
Operating system Linux/macOS for local development; Linux recommended for CI and production

Base install

pip install dpone
dpone --version
dpone -v
dpone --help

Install connector extras

Install only what your pipeline needs:

pip install "dpone[postgres]"
pip install "dpone[mssql]"
pip install "dpone[clickhouse]"
pip install "dpone[kafka]"
pip install "dpone[gcp]"

For a local sandbox or CI image that should include all public integrations:

pip install "dpone[full]"

Optional native tools

Some fast paths use native vendor utilities in addition to Python packages.

Tool Needed for Check
bcp Fast MSSQL bulk import/export bcp -v
sqlcmd SQL Server bootstrap and diagnostics sqlcmd -?
ODBC Driver 18 MSSQL connectivity through pyodbc odbcinst -q -d
clickhouse-client Direct ClickHouse TSV import/export paths clickhouse-client --version
Docker Local integration stack docker info

Smoke test

dpone --help
dpone --version
dpone -v
dpone doctor --profile local

doctor is intentionally diagnostic. A missing optional connector should be a warning until your manifest actually needs it.

Next steps