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.5.0.tar.gz (215.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.5.0-py3-none-any.whl (233.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dbdocs-1.5.0.tar.gz
  • Upload date:
  • Size: 215.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.5.0.tar.gz
Algorithm Hash digest
SHA256 91985af9461299a3709bb286d653f0ec4dc497b5549bd95bcd05f4bd479fe172
MD5 bab9e96002a6e8265c41f4ce3dbd2364
BLAKE2b-256 661942a48e57ef41ad2c498989d155a68bf9c2ddbcd8e2e027db1642d1fe52da

See more details on using hashes here.

Provenance

The following attestation bundles were made for dbdocs-1.5.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.5.0-py3-none-any.whl.

File metadata

  • Download URL: dbdocs-1.5.0-py3-none-any.whl
  • Upload date:
  • Size: 233.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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f2dfc1a35e3bf4c90edb6a456f8dc18e46bfd20b54a00dbe08ed499ab452b60a
MD5 f28669065445d4168bd10f31f97b35c6
BLAKE2b-256 77fad3fd430b8e5c0fd466ef1242ae9078efadb35be5b7ed27ebb031cc71591f

See more details on using hashes here.

Provenance

The following attestation bundles were made for dbdocs-1.5.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