dbt-score 0.1.1

Linter for dbt model metadata.

dbt-score

Linter for dbt model metadata.

Development

Prerequisites

You'll need the following prerequisites:

• Any Python version starting from 3.11
• pre-commit
• PDM

Configure development environment running these commands from the project's root:

pre-commit install
pdm install --group :all

The pdm command will install all project's dependency groups, including all the dependencies needed for development purposes.

Lint

dbt_score uses:

• ruff for fast linting and formatting.
• mypy for type checking.
• pre-commit-hooks.
• prettier-hooks.

Cheatsheet:

pdm run ruff check .
pdm run ruff check --fix
pdm run mypy .
pdm run tox -e lint

Test

dbt_score uses:

• pytest as a main test framework.
• coverage for test coverage.
• tox for testing against multiple Python versions.

Cheatsheet:

pdm run tox -e py
pdm run pytest
pdm run coverage run -m pytest

Docs

dbt_score uses:

• mkdocs for docs generation.
• mkdocstrings for automatic docs from sources.

Cheatsheet:

pdm run mkdocs build
pdm run mkdocs serve

Pre-commit

Cheatsheet:

Execute hooks manually:

pre-commit run --all-files

Create a commit bypassing hooks:

git commit --no-verify