Skip to content

Install with pre-commit

Debby provides pre-commit hooks for running checks whenever your developers add a new model to your project. The pre-commit hook provides fast feedback to developers because it runs before your CI process, although using the hooks is a more advanced workflow to support.

To run Debby with pre-commit, add a file named .pre-commit-config.yaml to the root of your repository (if you do not have one already).

Then add the following content.

# .pre-commit-config.yaml
repos:
- repo: https://www.github.com/tjwaterman99/debby-pre-commit
  rev: v0.1.0
  hooks:
    - id: debby

Ensure pre-commit is installed on your system.

pip install pre-commit

Then install the hooks with

pre-commit install

The source code for the pre-commit hooks are available on its GitHub repository.

https://github.com/tjwaterman99/debby-pre-commit/