Skip to main content

Scaffold production-ready dbt projects with opinionated defaults

Project description

dbt-forge

dbt-forge is a Python CLI for scaffolding opinionated dbt projects with a consistent layout, starter models, adapter-specific profiles, and optional CI / SQLFluff setup. The project is currently in its 0.1.x alpha phase.

Features

  • src/-packaged Python CLI built on Typer and Rich
  • Interactive or default-driven project generation
  • Adapter templates for BigQuery, Snowflake, PostgreSQL, DuckDB, Databricks, Redshift, Trino, and Spark
  • add mart and add source commands for extending an existing dbt project
  • Optional starter dbt packages, SQLFluff config, and CI templates
  • Generated .env support so local dbt commands resolve profiles/ consistently

Install

pip install dbt-forge

Or with uv:

uv tool install dbt-forge

Quickstart

dbt-forge init

For a non-interactive scaffold:

dbt-forge init my_dbt_project --defaults

Add a mart or source inside an existing dbt project:

dbt-forge add mart finance
dbt-forge add source salesforce

Supported Python

  • Python 3.11
  • Python 3.12
  • Python 3.13

Local Development

cd cli
uv sync --all-groups
uv run pre-commit install --hook-type commit-msg
uv run ruff check .
uv run pytest
uv build
uvx twine check dist/*

Commit Messages

This repo uses Conventional Commits. Every commit message must start with a type such as:

  • feat: add databricks profile scaffolding
  • fix: handle missing target directory
  • chore: refresh release workflow

The local commit-msg hook enforces this after you run:

uv run pre-commit install --hook-type commit-msg

Release Process

The package publishes from GitHub Actions on v* tags. The website in this repo is supporting docs/marketing and is not a separately versioned release artifact.

  1. Update src/dbt_forge/__init__.py if the version changes.
  2. Add release notes to the repository CHANGELOG.md.
  3. Run the release-candidate checks.
  4. Run the manual TestPyPI preflight from the Release workflow.
  5. Push a tag in the form vX.Y.Z.
  6. Let GitHub Actions publish the artifact to PyPI via Trusted Publishing.

For the detailed checklist and publish prerequisites, see RELEASING.md.

Publishing Setup

  • Public repo: maroil/dbt-forge
  • Configure GitHub environments named pypi and testpypi
  • Register the GitHub repo as a Trusted Publisher in PyPI and TestPyPI

License

MIT. See LICENSE.

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_forge-0.1.1.tar.gz (22.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_forge-0.1.1-py3-none-any.whl (30.6 kB view details)

Uploaded Python 3

File details

Details for the file dbt_forge-0.1.1.tar.gz.

File metadata

  • Download URL: dbt_forge-0.1.1.tar.gz
  • Upload date:
  • Size: 22.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for dbt_forge-0.1.1.tar.gz
Algorithm Hash digest
SHA256 7b6709c3831a70e34c689883066a8d511007fba356fcf40ecb12bd0046f0f608
MD5 b20e7878d6e1f9b3be907ad46b810d9a
BLAKE2b-256 a3fdd5391554cc0740fa44abdc9d7607905bf681ad44ba1a9e18fec88e321a2f

See more details on using hashes here.

Provenance

The following attestation bundles were made for dbt_forge-0.1.1.tar.gz:

Publisher: release.yml on maroil/dbt-forge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dbt_forge-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: dbt_forge-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 30.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for dbt_forge-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 aba7ede6daf059c95f1b605a7c3f869ea260aae184a13cff3b29ceb9d72bb1a2
MD5 65de2c20bdcbef8d77ad1cc87f5a57d9
BLAKE2b-256 cf2ea59c7f1e21d75b4a0c9684e82a12ba517255172070de59be69860fbd7fff

See more details on using hashes here.

Provenance

The following attestation bundles were made for dbt_forge-0.1.1-py3-none-any.whl:

Publisher: release.yml on maroil/dbt-forge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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