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

Live demo of dashboard: https://b-ned.github.io/colibri-demo/

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 ✅ Tested
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.3.tar.gz (444.9 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.3-py3-none-any.whl (438.7 kB view details)

Uploaded Python 3

File details

Details for the file dbt_colibri-0.2.3.tar.gz.

File metadata

  • Download URL: dbt_colibri-0.2.3.tar.gz
  • Upload date:
  • Size: 444.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.12

File hashes

Hashes for dbt_colibri-0.2.3.tar.gz
Algorithm Hash digest
SHA256 3f303b4994251bae0088e2a26d5588d12dfa7009746e00d935146b5c8e461e0e
MD5 9c97a2a72c2ed6b817a49110b59ea0a7
BLAKE2b-256 0069902af0f89f47626d99f51dc5b1bbb76659b67d9f92b4169f5b07bbdfb881

See more details on using hashes here.

File details

Details for the file dbt_colibri-0.2.3-py3-none-any.whl.

File metadata

File hashes

Hashes for dbt_colibri-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 16f1bc2c444e5aaba0b410c1d0e56b0c78325ff6f881016690eed2b65649d090
MD5 02dcfb3f9d2831f7521a5c3ccf348f26
BLAKE2b-256 4a84363d184ffad207ab8573609064536395fcbfbf5d369c772a9d03ffbc6ac7

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