Metadata-Version: 2.4
Name: docglow
Version: 0.1.0
Summary: Next-generation dbt documentation site generator
Project-URL: Homepage, https://github.com/docglow/docglow
Project-URL: Documentation, https://github.com/docglow/docglow#readme
Project-URL: Repository, https://github.com/docglow/docglow
Project-URL: Changelog, https://github.com/docglow/docglow/blob/main/CHANGELOG.md
Project-URL: Bug Tracker, https://github.com/docglow/docglow/issues
Author: Josh
License-Expression: MIT
License-File: LICENSE
Keywords: analytics-engineering,data-catalog,data-documentation,dbt,dbt-core,documentation,lineage
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Database
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: click>=8.1
Requires-Dist: jinja2>=3.1
Requires-Dist: pydantic>=2.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: rich>=13.0
Provides-Extra: ai
Requires-Dist: anthropic>=0.40; extra == 'ai'
Provides-Extra: cloud
Requires-Dist: httpx>=0.27; extra == 'cloud'
Provides-Extra: dev
Requires-Dist: mypy>=1.10; extra == 'dev'
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.8; extra == 'dev'
Provides-Extra: profiling
Requires-Dist: duckdb-engine>=0.11; extra == 'profiling'
Requires-Dist: sqlalchemy>=2.0; extra == 'profiling'
Description-Content-Type: text/markdown

# docglow

Next-generation documentation site generator for [dbt Core](https://github.com/dbt-labs/dbt-core) projects.

Docglow replaces the default `dbt docs generate` + `dbt docs serve` workflow with a modern, interactive single-page application featuring lineage exploration, column-level docs, test results, and project health scoring — at a fraction of the cost of enterprise data catalogs.

## Install

```bash
pip install docglow
```

## Quick Start

```bash
# 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
- **Test results dashboard** — per-model test outcomes with pass/fail/warn indicators
- **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]`) |
| `docglow publish` | Publish to docglow.dev (requires `docglow[cloud]`) |

## 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
