/dbtwiz

Python package with CLI helper tool for dbt

Primary LanguagePythonMIT LicenseMIT

dbtwiz

Python package with CLI helper tool for dbt

Installation

pip install git+https://github.com/amedia/dbtwiz

Development

# where you keep locally checked out repos:
git clone git@github.com:amedia/dbtwiz

# inside the virtual environment of your dbt project:
pip install -e <local-path-to-dbtwiz-repository>

Configuration

The default configuration of dbtwiz will be installed the first time you run it, but you may want to adjust some settings from the get-go to fit your environment.

Dark mode

If you're using a dark background colour in your terminal, you should configure dbtwiz to use bright colours for highlighting in previews and elsewhere to make the text more readable.

Run the following command to switch from default light mode to dark mode:

$ dbtwiz config theme dark

Preview formatter

By default, dbtwiz uses the command fmt tool to format text in the preview window when selecting models interactively. Under macOS, the fmt tool won't handle ANSI escape codes, and unless you have the GNU coreutils version of fmt you will get garbage characters in the preview window, and should switch to the simple cat command for formatting instead:

$ dbtwiz config model_info:formatter "cat -s"

Subcommands