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.

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.1.tar.gz (7.5 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.1-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dbtfetch-1.0.1.tar.gz
  • Upload date:
  • Size: 7.5 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.1.tar.gz
Algorithm Hash digest
SHA256 7d263dfd0e1efe92720f1a9239368196fcf811c8a127b3fd639a6a4f90583b51
MD5 cc8ce5c9f26bcfe67ab7fbfa022ab0eb
BLAKE2b-256 aaa89324e63d7760929c03edd7070c08bc57134ed2833729cd0530b5f6bbe786

See more details on using hashes here.

File details

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

File metadata

  • Download URL: dbtfetch-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 7.5 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f154fef351c6099786455587f185658650802e14a95d1e75811f9715e3cf44cb
MD5 23d558a19a197a1bab10af64e3114909
BLAKE2b-256 bd850589dab757701ddb2b9be4138596785ac8673e3fcff296d9883c6a0d817a

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