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, baked into one file.

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

Turn your dbt artifacts into a single self-contained index.html: a browsable catalog, an interactive lineage DAG and ERD, and column-level lineage from your compiled SQL. No server, no database, no build step — just a file you can open or host anywhere.

Catalog Model page Lineage DAG
catalog model page dag

Install

pip install dbdocs --upgrade

Requires Python 3.10+.

Quickstart

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

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

Why dbdocs?

dbt's own docs are great until you want lineage at the column level — that's the gap this fills. Everything is derived from your dbt manifest.json / catalog.json and baked into one offline-friendly SPA: catalog navigation grouped by database/schema, per-model SQL and columns, interactive React Flow graphs, column-level lineage via sqlglot, client-side search, a dark/light theme, and versioned deploys with a built-in version switcher.

See the docs for the deep dives.

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-0.0.0.tar.gz (175.4 kB view details)

Uploaded Source

Built Distribution

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

dbdocs-0.0.0-py3-none-any.whl (183.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dbdocs-0.0.0.tar.gz
Algorithm Hash digest
SHA256 860df8e8ad2d41bf73bd864ff771f33365e2fa4be3cf7ad58f89db3f91de0751
MD5 a1339976a43dc3b097c7ba51f619f2b0
BLAKE2b-256 e767d1b4cc87775bec56736307e92367a298f3ea5ea603648fc670e04affbc05

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for dbdocs-0.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ad9093e82ad299882d2129bc7b93879f63e1ba38ea8b8dc3e556650e5bb2c01a
MD5 e0b77c4d243257c46e5f0564c0d6f6b6
BLAKE2b-256 dfb716a751d86d5174dd56bc827dceb46e853fbbce7c4d4c3e3d4077c8e3d463

See more details on using hashes here.

Provenance

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