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-1.1.0.tar.gz (182.9 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.1.0-py3-none-any.whl (192.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dbdocs-1.1.0.tar.gz
Algorithm Hash digest
SHA256 5f6b8556256cd5ef40d413e01fe7723464eb7e9c63b8edee4401a53aa7ad29fd
MD5 4330db6d7cf57cc2d921fb511b8fd4b0
BLAKE2b-256 0e6b49db71a798dccd64427b613fdd3f0dc2a7599c7f69975ced3978f8e58d89

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: dbdocs-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 192.3 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2342e17ee0536a34ee6b160a831970d125b755d9395ab9d062e9c59df71e8a86
MD5 513bd31b6ebb45b537744149fa01e460
BLAKE2b-256 2524232426c6868bd58267fb0182e42bd378a7557ee9f6ee61402d9dd293985a

See more details on using hashes here.

Provenance

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