Skip to main content

Alternative dbt docs site: Catalog + ERD + column-level lineage

Project description

dbdocs logo

An alternative dbt docs site — catalog + ERD + column-level lineage + versioned deploys, all in one CLI.

live demo docs PyPI version python-cli License: MIT python

Turn your dbt artifacts into a self-contained docs site: a browsable catalog, an entity-relationship diagram, an interactive lineage DAG, and column-level lineage traced from your compiled SQL — all in one dbdocs generate. Serve it with dbdocs serve, or deploy versioned builds anywhere a static host will take them.

Catalog Model page Lineage DAG Health Check
catalog model page dag health check

Why dbdocs?

dbt's built-in docs stop short of telling you which upstream column fed this downstream column, which tables relate to each other, or what changed between builds. dbdocs fills those gaps — no documentation framework or separate ERD tool to install.

  • ERD + column-level lineage — table relationships (dbterd) and column lineage from compiled SQL (sqlglot).
  • Column impact analysis — downstream dependents for any column.
  • Deep-link URLs for every node, column, and DAG view.
  • Any sqlglot dialect, auto-detected from your manifest.
  • Scales to 1 000s of models without freezing the browser.
  • Fail-soft — an unparseable model is skipped, not fatal.
  • Project Health Check across the six dbt-project-evaluator dimensions.
  • Versioned deploys with a built-in version switcher, no plugins.
  • Full-text search across names, columns, descriptions, tags, and SQL at the client-side, no backend.
  • Dark / light theme.

Install

pip install dbdocs --upgrade

Requires Python 3.10+.

Quickstart

dbt docs generate     # writes target/manifest.json + target/catalog.json
dbdocs generate       # builds ./site/ with index.html + dbdocs-data.json.gz
dbdocs serve          # static http server on http://127.0.0.1:8000

The site must be served over HTTP (not opened as a local file) because it fetches the data payload at load time. dbdocs serve handles that locally; any static host works for deployment.

Full walkthrough, configuration, and architecture live in the documentation.

Contributing

Contributions are welcome — bugs, features, docs, typos. See the Contributing Guide.

If dbdocs saves you some clicks, consider buying me a coffee.

buy me a coffee

License

MIT © Dat Nguyen

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

dbdocs-1.4.0.tar.gz (213.8 kB view details)

Uploaded Source

Built Distribution

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

dbdocs-1.4.0-py3-none-any.whl (231.4 kB view details)

Uploaded Python 3

File details

Details for the file dbdocs-1.4.0.tar.gz.

File metadata

  • Download URL: dbdocs-1.4.0.tar.gz
  • Upload date:
  • Size: 213.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for dbdocs-1.4.0.tar.gz
Algorithm Hash digest
SHA256 b1f2fca15860e6790aa3437b9ae03d4ef773bbe30e8c092d91b2f3fa41fe6646
MD5 e75b378fa042afde372da86859c6acb0
BLAKE2b-256 a2865f1564c86b198aa78e623c1d1410c967f8d2151418da2a2f64d906debe25

See more details on using hashes here.

Provenance

The following attestation bundles were made for dbdocs-1.4.0.tar.gz:

Publisher: pypi-publish.yml on datnguye/dbt-docs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dbdocs-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: dbdocs-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 231.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for dbdocs-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1ef655145e77f9fdc16366dd29839311b20ea943d5a24b08a495c6a5d1a9b4e7
MD5 5dc0590d9582b142db802ea4a923eef6
BLAKE2b-256 0d22c5f43a3a996c59927284a5daa208e0e255abcf284cae6dba8ef7e4c02277

See more details on using hashes here.

Provenance

The following attestation bundles were made for dbdocs-1.4.0-py3-none-any.whl:

Publisher: pypi-publish.yml on datnguye/dbt-docs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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