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

The easiest way to deploy your static html is through github/gitlab pages (if you are on enterprise license you can do this privately)

You can find the full example workflow at docs/github_pages_example.yml.

General idea

  1. After every change to the production dbt code (push the main branch), GitHub Actions will:
    • Set up Python and install dependencies with uv.
    • Compile and generate docs needed for colibri.
    • Run colibri generate to build the static HTML report in the dist/ folder.
  2. The dist/ folder is uploaded as an artifact and deployed natively to GitHub Pages using the official actions/deploy-pages action.
  3. The result is available at your repository’s Pages URL.

Gitlab has similar functionality. Other options are writing the file to a bucket and mount it into a web server container (nginx).

🛠️ 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.4.tar.gz (448.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.4-py3-none-any.whl (441.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dbt_colibri-0.2.4.tar.gz
Algorithm Hash digest
SHA256 ee922fc530848611516d3c08c3e94f033e0feb59bd1c72a9e77eb20bee1471bf
MD5 1b5b9656af6962339b6322f0129badb2
BLAKE2b-256 569f0f5fde6936386f7b30ca2000ba2b1fe3e8068e449bff0caa3e15caa5e3d1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for dbt_colibri-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 6a4f40c0f4c50842ec6153e3060139b9a3f6330bad78d621ab206f46b9c9830f
MD5 05af8913c0d45f4c27ec158769417fe0
BLAKE2b-256 250cfe72897483a9012247fbbe5fd76c9d465dd6b8aae1e1100b3a83bc733761

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