Awesome

<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.6-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.

TLDR

Install dbt-bouncer:
```
pip install dbt-bouncer
```
dbt-bouncer requires a manifest.json file. If not already present, run:
```
dbt parse
```

Create a dbt-bouncer.yml config file:

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_

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.
Want to help us build dbt-bouncer? Check out the Contributing Guide.

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.