Skip to main content

A column lineage parser and dashboarding tool

Project description

dbt-colibri header

PyPI version Python Support License: MIT

A lightweight, developer-friendly CLI tool and self-hostable dashboard for extracting and visualizing column-level lineage from your dbt projects.

Built for data teams who want transparent, flexible lineage tracking without vendor lock-in or complex enterprise tooling.

🎯 Why dbt-colibri?

  • 🔍 Complete visibility: Easy UI, track how every column flows through your dbt transformations
  • ⚡ Fast & lightweight: Generate reports in seconds from your existing dbt artifacts
  • 🏠 Self-hosted: No cloud dependencies or external services required

dbt-colibri dashboard

🚀 Quick Start

Installation

# Using uv (recommended)
uv add dbt-colibri

# Using pip
pip install dbt-colibri

Basic Usage

  1. Run dbt to generate the required artifacts:

    dbt compile
    dbt docs generate
    
  2. Generate lineage report:

    colibri generate
    
  3. View results: Open dist/index.html in your browser

That's it! Your column lineage dashboard is ready. Note you can also use dbt run, to generate the manifest.json.

📖 Documentation

CLI Commands

colibri generate

Generates column lineage reports from your dbt project.

colibri generate [OPTIONS]

Options:

  • --manifest-path: Path to dbt manifest.json (default: target/manifest.json)
  • --catalog-path: Path to dbt catalog.json (default: target/catalog.json)
  • --output-dir: Output directory (default: dist/)
  • --help: Show help message

Output Files

  • colibri-manifest.json: Lineage data
  • index.html: Interactive (standalone) visualization dashboard

Project Structure

your-dbt-project/
├── target/
│   ├── manifest.json    # Generated by dbt
│   └── catalog.json     # Generated by dbt docs generate
└── dist/                # Generated by colibri
    ├── index.html       # Interactive dashboard
    └── colibri-manifest.json

🔧 Advanced Usage

CI/CD Integration (W.I.P)

Todo: Instructions on how to add to your CI pipeline to automatically generate and deploy lineage documentation.

🛠️ Technical Details

Requirements

  • Python: tested on versions 3.9, 3.11, 3.13

  • Database: Currently only tested with Snowflake dialect

dbt Compatibility

dbt-core Version Status
1.8.x ✅ Tested
1.9.x 🔲 Testing in progress
1.10.x ✅ Tested

Architecture

dbt-colibri leverages:

  • SQLGlot for SQL parsing and column lineage extraction
  • dbt artifacts (manifest.json, catalog.json) for metadata
  • Static HTML/JS for zero-dependency dashboard deployment

🤝 Contributing

We welcome contributions! Raise an issue or request a feature, if you are open to contribute you can let us now in the issue.

Development Setup

# Clone the repository
git clone https://github.com/your-org/dbt-colibri.git
cd dbt-colibri

# Install development dependencies
uv sync --dev

# Run tests
pytest

# Format code
ruff format

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

This project builds upon excellent open source work:

📞 Support


From one dbt user to another — built to make your workflow better.

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

dbt_colibri-0.2.1b4.tar.gz (429.6 kB view details)

Uploaded Source

Built Distribution

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

dbt_colibri-0.2.1b4-py3-none-any.whl (425.4 kB view details)

Uploaded Python 3

File details

Details for the file dbt_colibri-0.2.1b4.tar.gz.

File metadata

  • Download URL: dbt_colibri-0.2.1b4.tar.gz
  • Upload date:
  • Size: 429.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.5

File hashes

Hashes for dbt_colibri-0.2.1b4.tar.gz
Algorithm Hash digest
SHA256 5ac4dc2f43a1294bdfe708094c8eb331d710dafd9663f50b409dc28abcb87941
MD5 d119e44d4e20def170d8b2a127ea63f3
BLAKE2b-256 e9b13f3e004097cf32daa9f31c4a21cf2c7f1358235415b04b6fc2939e40d5ed

See more details on using hashes here.

File details

Details for the file dbt_colibri-0.2.1b4-py3-none-any.whl.

File metadata

File hashes

Hashes for dbt_colibri-0.2.1b4-py3-none-any.whl
Algorithm Hash digest
SHA256 ad780c901c3de704c6070d993801bd27914f8df7626bd5c071334bccb442e1c6
MD5 804583075db8218a539c97acc0ab92d6
BLAKE2b-256 c2d4ace5642d0636aea8262f4b7ae7e1dc28465f9acb9498e1bc2ddd169d8505

See more details on using hashes here.

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