Skip to main content

Next-generation dbt documentation site generator

Project description

docglow

Next-generation documentation site generator for dbt Core projects.

Docglow replaces the default dbt docs serve workflow with a modern, interactive single-page application featuring lineage exploration, documentation serving, and project health scoring.

Install

pip install docglow

Quick Start

# Generate the site from your dbt project
docglow generate --project-dir /path/to/dbt/project --output-dir ./site

# Serve locally
docglow serve --dir ./site

Features

  • Interactive lineage explorer — drag, filter, and explore upstream/downstream dependencies with configurable depth and layer visualization
  • Column-level documentation — searchable column tables with descriptions, types, and test status
  • Project health score — coverage metrics for descriptions, tests, and documentation completeness
  • Full-text search — instant search across all models, sources, and columns
  • Single static site — no backend required, deploy anywhere (S3, GitHub Pages, Netlify, etc.)

CLI Commands

Command Description
docglow generate Generate the documentation site from dbt artifacts
docglow serve Serve the generated site locally
docglow health Show project health score and coverage metrics
docglow profile Run column-level profiling (requires docglow[profiling])

Configuration

Add a docglow.yml to your dbt project root for optional customization (layer definitions, display settings, etc.). Docglow works out of the box without any configuration — just point it at a dbt project with compiled artifacts in target/.

Requirements

  • Python 3.10+
  • A dbt project with target/manifest.json (run dbt compile or dbt run first)

License

MIT

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

docglow-0.2.0.tar.gz (262.1 kB view details)

Uploaded Source

Built Distribution

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

docglow-0.2.0-py3-none-any.whl (276.1 kB view details)

Uploaded Python 3

File details

Details for the file docglow-0.2.0.tar.gz.

File metadata

  • Download URL: docglow-0.2.0.tar.gz
  • Upload date:
  • Size: 262.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for docglow-0.2.0.tar.gz
Algorithm Hash digest
SHA256 cf6b561a3ddb9a69ed9e36f554669631f7b683c640da97287db79173f1d9ae8e
MD5 66d1256a3f0b62fc2ad9216c525edff9
BLAKE2b-256 f035a734e942baefd53d02d299bfbfb1941c77e4e60aef9d73334109fc946556

See more details on using hashes here.

Provenance

The following attestation bundles were made for docglow-0.2.0.tar.gz:

Publisher: publish.yml on docglow/docglow

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

File details

Details for the file docglow-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: docglow-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 276.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for docglow-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4cb26e66e0b40bc22cbc31b65183cab1bad117cf83bbf2aff7b7231aacaf8ad3
MD5 c318872393dd4e0f081267b9f14c4277
BLAKE2b-256 42edda21a1a8666249756ad471102b25331ed155ede7dbf9be96c81561a638b1

See more details on using hashes here.

Provenance

The following attestation bundles were made for docglow-0.2.0-py3-none-any.whl:

Publisher: publish.yml on docglow/docglow

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