Metadata-Version: 2.4
Name: dbt-bouncer
Version: 1.31.2rc3
Summary: Configure and enforce conventions for your dbt project.
Author-email: Padraic Slattery <pgoslatara@gmail.com>
Maintainer-email: Padraic Slattery <pgoslatara@gmail.com>
License-Expression: MIT
Project-URL: repository, https://github.com/godatadriven/dbt-bouncer
Keywords: python,cli,dbt,CI/CD
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: <3.14,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click<9
Requires-Dist: dbt-artifacts-parser>=0.8
Requires-Dist: h11>=0.16.0
Requires-Dist: jellyfish<2,>=1
Requires-Dist: jinja2<4,>=3
Requires-Dist: jinja2-simple-tags<1
Requires-Dist: packaging<25
Requires-Dist: progress
Requires-Dist: pydantic<3,>=2
Requires-Dist: pyyaml<7
Requires-Dist: requests<3,>=2
Requires-Dist: tabulate<1
Requires-Dist: toml<1
Requires-Dist: semver<4
Provides-Extra: dev
Requires-Dist: autoflake~=2.0; extra == "dev"
Requires-Dist: black~=25.0; extra == "dev"
Requires-Dist: dbt-core<2,>=1.10.0; extra == "dev"
Requires-Dist: dbt-duckdb~=1.0; extra == "dev"
Requires-Dist: isort~=7.0; extra == "dev"
Requires-Dist: mypy~=1.0; extra == "dev"
Requires-Dist: pre-commit<5,>=3; extra == "dev"
Requires-Dist: pytest<=10; extra == "dev"
Requires-Dist: pytest-cov<8,>=5; extra == "dev"
Requires-Dist: pytest-xdist~=3.0; extra == "dev"
Requires-Dist: ruff~=0.0; extra == "dev"
Requires-Dist: shandy-sqlfmt[jinjafmt]~=0.0; extra == "dev"
Requires-Dist: types-PyYaml~=6.0; extra == "dev"
Requires-Dist: types-tabulate~=0.0; extra == "dev"
Requires-Dist: types-toml~=0.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: mike~=2.0; extra == "docs"
Requires-Dist: mkdocs~=1.0; extra == "docs"
Requires-Dist: mkdocstrings-python<2; extra == "docs"
Requires-Dist: mkdocs-click~=0.0; extra == "docs"
Requires-Dist: mkdocs-git-revision-date-localized-plugin~=1.0; extra == "docs"
Requires-Dist: mkdocs-material~=9.0; extra == "docs"
Requires-Dist: pymdown-extensions~=10.0; extra == "docs"
Dynamic: license-file

<p align="center">
  <img src="https://github.com/godatadriven/dbt-bouncer/raw/main/docs/assets/logo.svg" alt="dbt-bouncer logo" width="500"/>
</p>


<h1 align="center">
  dbt-bouncer
</h1>
<h2 align="center">
  Configure and enforce conventions for your dbt project.
</h2>

<div align="center">
  <a>
	<img src="https://img.shields.io/github/release/godatadriven/dbt-bouncer.svg?logo=github">
  </a>
  <a>
	<img src="https://img.shields.io/badge/License-MIT-yellow.svg">
  </a>
  <a>
	<img src="https://img.shields.io/github/last-commit/godatadriven/dbt-bouncer/main">
  </a>
  <a>
	<img src="https://img.shields.io/github/commits-since/godatadriven/dbt-bouncer/latest">
  </a>
</div>

<div align="center">
  <a>
	<img alt="dbt-core" src="https://img.shields.io/badge/dbt--core%20-%3E%3D1.7-333?logo=dbt">
  </a>
  <a>
	<img alt="dbt Cloud Supported" src="https://img.shields.io/badge/dbt%20Cloud%20-Supported-ff694a?logo=dbt">
  </a>
  <a>
	<img alt="Docker Supported" src="https://img.shields.io/badge/Docker%20-Supported-0db7ed?logo=docker">
  </a>
  <a>
	<img alt="GitHub Supported" src="https://img.shields.io/badge/GitHub%20-Supported-333?logo=github">
  </a>
</div>

<div align="center">
  <a>
	<img src="https://github.com/godatadriven/dbt-bouncer/actions/workflows/merge_pipeline.yml/badge.svg">
  </a>
  <a>
	<img src="https://github.com/godatadriven/dbt-bouncer/actions/workflows/post_release_pipeline.yml/badge.svg">
  </a>
  <a>
	<img src="https://img.shields.io/badge/style-ruff-41B5BE?style=flat">
  </a>
  <a>
	<img src="https://www.aschey.tech/tokei/github/godatadriven/dbt-bouncer?category=code">
  </a>
</div>
<br/>

## Documentation

All documentation can be found on `dbt-bouncer` [documentation website](https://godatadriven.github.io/dbt-bouncer/).

### TLDR

1. Install `dbt-bouncer`:

    ```shell
    pip install dbt-bouncer
    ```

1. `dbt-bouncer` requires a `manifest.json` file. If not already present, run:

    ```shell
    dbt parse
    ```

1. Create a `dbt-bouncer.yml` config file:

    ```yml
    manifest_checks:
      - name: check_model_directories
        include: ^models
        permitted_sub_directories:
          - intermediate
          - marts
          - staging
      - name: check_model_names
        include: ^models/staging
        model_name_pattern: ^stg_
    ```

1. Run `dbt-bouncer`:

    ```
    $ dbt-bouncer

    [...]
    Running checks... |################################| 20/20
    Done. SUCCESS=19 WARN=0 ERROR=1
    Failed checks:
    | Check name               | Severity | Failure message                                                                       |
    |--------------------------|----------|---------------------------------------------------------------------------------------|
    | check_model_directories: | error    | AssertionError: `model` is located in `utilities`, this is not a valid sub-directory. |
    ```

## Reporting bugs and contributing code

- Want to report a bug or request a feature? Let us know and open [an issue](https://github.com/godatadriven/dbt-bouncer/issues/new/choose).
- Want to help us build `dbt-bouncer`? Check out the [Contributing Guide](https://github.com/godatadriven/dbt-bouncer/blob/HEAD/docs/CONTRIBUTING.md).

## Code of Conduct

Everyone interacting in `dbt-bouncer`'s codebase, issue trackers, chat rooms, and mailing lists is expected to follow the [Code of Conduct](./CODE_OF_CONDUCT.md).
