Skip to main content

A neofetch-style system information tool for dbt projects

Project description

dbtfetch

A neofetch-style system information tool for dbt projects.

.:===-..                .:===-.       my_dbt_project@dbt
.========-..          .:========:     ------------------
:===========-.     .-============.    Project: my_dbt_project
.:=============-:. .-===========.     Version: 1.0.0
 .:================..=========-.      Profile: my_profile
  .:==========================.       dbt Version: 1.6.0
    :=======================-         
    .:=====================-.         Models: 45
      =========. .-========.          Tests: 23
     .=========:..-========.          Macros: 8
    .:======================.         Snapshots: 2
    :========================.        Seeds: 3
  .-==========================.       Packages: 5
 .-=========:..================.      
.-===========:. .:-=============.     SQL Lines: 3,247
:===========:.     ..============.    
.-=======:.           ..-=======.     Git Branch: main
 ..-==..                  .:=-..      Last Commit: 2 days ago

Features

  • 🎨 Beautiful ASCII art display of your dbt project statistics
  • 📊 Project metrics including models, tests, macros, snapshots, and seeds
  • 📦 Package dependency counting
  • 🔢 Total SQL lines of code
  • 🌿 Git branch and last commit information
  • 🎯 Automatic project detection (searches current and parent directories)
  • 🛠️ Support for custom project directory paths

Installation

Using pipx (recommended)

pipx install dbtfetch

Using pip

pip install dbtfetch

Usage

Analyze current directory

dbtfetch

Analyze a specific dbt project

dbtfetch /path/to/your/dbt/project

Show help

dbtfetch --help

Example Output

.:===-..                .:===-.       my_dbt_project@dbt
.========-..          .:========:     ------------------
:===========-.     .-============.    Project: my_dbt_project
.:=============-:. .-===========.     Version: 1.0.0
 .:================..=========-.      Profile: my_profile
  .:==========================.       dbt Version: 1.6.0
    :=======================-         
    .:=====================-.         Models: 45
      =========. .-========.          Tests: 23
     .=========:..-========.          Macros: 8
    .:======================.         Snapshots: 2
    :========================.        Seeds: 3
  .-==========================.       Packages: 5
 .-=========:..================.      
.-===========:. .:-=============.     SQL Lines: 3,247
:===========:.     ..============.    
.-=======:.           ..-=======.     Git Branch: main
 ..-==..                  .:=-..      Last Commit: 2 days ago

Requirements

  • Python 3.8 or higher
  • PyYAML
  • dbt installed (optional, for version detection)
  • Git (optional, for repository information)

Development

Clone the repository

git clone https://github.com/yourusername/dbtfetch.git
cd dbtfetch

Install in development mode

pip install -e .

License

MIT License - see LICENSE file for details

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Author

Your Name - your.email@example.com

Acknowledgments

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

dbtfetch-1.0.0.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

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

dbtfetch-1.0.0-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

Details for the file dbtfetch-1.0.0.tar.gz.

File metadata

  • Download URL: dbtfetch-1.0.0.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for dbtfetch-1.0.0.tar.gz
Algorithm Hash digest
SHA256 75d1a4b2bb1a84453dcee0b1b73914de3665d03fa4c633536e42516785ae0e15
MD5 83c2ed144db8205f7db8d975e70d3457
BLAKE2b-256 c747bf53a5608990c6cac1418f9c31805683cfe32f15aa1f2ff14de26c43e99e

See more details on using hashes here.

File details

Details for the file dbtfetch-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: dbtfetch-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 7.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for dbtfetch-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 68e94af8bf291e471a8555ac3af2c926f35a79dd37e0fc9a854714474f044684
MD5 dc60805e56b599ae72f828e83187e01f
BLAKE2b-256 39b09b117ebf147d9a18e7f8dc00f80bedb70e7817450217b0833fc440891774

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