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.2.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.2-py3-none-any.whl (425.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dbt_colibri-0.2.2.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.2.tar.gz
Algorithm Hash digest
SHA256 4c32c76df977ac272656f1ffe733e68c254f8e6befd8c577f1914584d78a6f4a
MD5 b12b61f018f558f68c339c287bd1f2f1
BLAKE2b-256 378a807658d184913083a63e1044020a65b0be4cfaa74c087c0e1a4f46af9517

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for dbt_colibri-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b31055ca52ece34d887106c6e3b3e2ab448cca7521a20f6bcc65eb5693495ea1
MD5 8acdef11ca15c23837c7747c6957fde0
BLAKE2b-256 71fbdae2013887a54860bf3da014296a6d4fc6473ad9b21aca8fc697ae5d5669

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