Configure project setup

.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: dbt-score
+
+on:
+  pull_request:
+    branches:
+      - master
+    paths-ignore:
+      - 'docs/**'
+
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - 'docs/**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: [ "3.8", "3.9", "3.10", "3.11" ]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up PDM
+        uses: pdm-project/setup-pdm@v3
+        with:
+          python-version: '3.8'
+
+      - name: Install dependencies
+        run: |
+          pdm sync -d
+      - name: Run Tox
+        run: |
+          pdm run tox -e py,lint

.gitignore

@@ -0,0 +1,97 @@
+# PyCharm
+.idea
+
+# VisualStudioCode
+.vscode
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# PyBuilder
+.pybuilder/
+target/
+
+# pdm
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# ruff
+.ruff_cache/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/

.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.5.0
+  hooks:
+    - id: check-added-large-files
+    - id: check-toml
+    - id: end-of-file-fixer
+    - id: trailing-whitespace
+-   repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.2.2
+    hooks:
+      - id: ruff
+        args: [ --fix ]
+        description: Run linter with fixes enabled
+      - id: ruff-format
+        description: Run formatter
+-   repo: local
+    hooks:
+      - id: tox
+        name: tox
+        description: Run tox
+        entry: pdm run tox -e py,lint
+        language: system
+        pass_filenames: false

docs/index.md

@@ -0,0 +1 @@
+# Welcome to dbt-score

mkdocs.yml

@@ -0,0 +1,8 @@
+site_name: dbt-score
+theme:
+  name: material
+plugins:
+  - search
+  - mkdocstrings
+nav:
+  - Home: index.md

pyproject.toml

@@ -0,0 +1,86 @@
+[build-system]
+requires = ["pdm-backend"]
+build-backend = "pdm.backend"
+
+[project]
+name = "dbt-score"
+dynamic = ["version"]
+
+description = "Linter for dbt model metadata."
+authors = [
+    {name = "Picnic Analyst Development Platform", email = "[email protected]"}
+]
+dependencies = [
+    "dbt-core~=1.7",
+]
+requires-python = ">=3.8"
+readme = "README.md"
+license = {text = "MIT"}
+
+[tool.pdm]
+[tool.pdm.dev-dependencies]
+dev = [
+    "tox-pdm~=0.7.2",
+    "tox~=4.13",
+]
+lint = [
+    "ruff~=0.2.2",
+    "mypy~=1.8",
+]
+test = [
+    "pytest~=8.0",
+    "coverage[toml]~=7.4"
+]
+docs = [
+    "mkdocs-material~=9.5",
+    "mkdocstrings[python]~=0.24.0"
+]
+
+[tool.pdm.version]
+source = "scm"
+
+### Mypy ###
+
+[tool.mypy]
+strict = true
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+disallow_untyped_defs = false
+disallow_incomplete_defs = false
+disallow_untyped_calls = false
+
+### Ruff ###
+
+[tool.ruff]
+line-length = 88
+
+[tool.ruff.lint]
+extend-select = [
+    "B", # flake8-bugbear
+    "C90", # mccabe
+    "I", # isort
+    "PL", # pylint
+    "Q", # flake8-quotes
+    "RUF", # ruff
+    "E", # pycodestyle errors
+    "W", # pycodestyle warnings
+]
+
+[tool.ruff.lint.mccabe]
+max-complexity = 10
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+### Coverage ###
+
+[tool.coverage.run]
+source = [
+    "tests",
+    "src"
+]
+
+[tool.coverage.report]
+show_missing = true
+fail_under = 80

src/dbt_score/__init__.py

@@ -0,0 +1 @@
+"""Init dbt_score package."""

tests/__init__.py

@@ -0,0 +1 @@
+"""Test dbt_score package."""

tests/conftest.py

@@ -0,0 +1,9 @@
+"""Test configuration."""
+
+from pytest import ExitCode, Session
+
+
+def pytest_sessionfinish(session: Session, exitstatus: int):
+    """Avoid ci failure if no tests are found."""
+    if exitstatus == ExitCode.NO_TESTS_COLLECTED:
+        session.exitstatus = ExitCode.OK

tox.ini

@@ -0,0 +1,24 @@
+[tox]
+env_list = py{38,39,310,311},lint,docs
+
+skip_missing_interpreters = true
+
+[testenv]
+description = Run tests
+groups = test
+commands =
+   pytest
+   coverage run -m pytest
+
+[testenv:lint]
+description = Run lint
+groups = lint, test
+commands =
+    ruff check .
+    mypy .
+
+[testenv:docs]
+description = Build docs
+groups = docs
+commands =
+    mkdocs build --clean