Adding contributing doc and pre-commit

.github/workflows/tests.yml → .github/workflows/linters-tests.yml

@@ -2,6 +2,26 @@ name: Tests
 on: pull_request
 
 jobs:
+  linters:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Install dependencies
+        run: |
+          pip install poetry
+          poetry config virtualenvs.create false
+          poetry install --no-root
+
+      - name: Run pre-commit
+        run: pre-commit run --all-files
+
   integration-tests:
     runs-on: ubuntu-latest
     steps:

.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-added-large-files
+      - id: check-json
+      - id: check-ast
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+        args: [--unsafe]
+      - id: debug-statements
+      - id: detect-private-key
+      - id: end-of-file-fixer
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2  # Use the same version as in pyproject.toml
+    hooks:
+      - id: isort
+        name: isort (python)
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 24.2.0  # Use the same version as in pyproject.toml
+    hooks:
+      - id: black
+        name: Run black formatter

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Support for `dbt==1.7`. [#72] _Thanks to @pgoslatara!_
 - Coverage type to string/markdown reports. [#74] _Thanks to @pgoslatara!_
+- Contributing guide and pre-commit. [#73] _Thanks to @pgoslatara!_
 
 ## [0.3.5] - 2023-11-09
 ### Added
@@ -39,7 +40,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.3.0] - 2022-11-17
 ### Added
 - Support for custom run artifacts path. [#33] _Thanks to @Fszta!_
-- Support for model selection by path. [#45] _Thanks to @followingell!_ 
+- Support for model selection by path. [#45] _Thanks to @followingell!_
 - Support for `compute doc` to print results in a markdown table format. [#47] _Thanks to @vvvito!_
 
 ## [0.2.3] - 2022-10-14

README.md

@@ -59,7 +59,7 @@ option.
 
 Compute coverage from `target/catalog.json` and `target/manifest.json` files
 found in a dbt project, e.g.
-[jaffle_shop](https://github.com/dbt-labs/jaffle_shop). 
+[jaffle_shop](https://github.com/dbt-labs/jaffle_shop).
 
 To choose between documentation and test coverage, pass `doc` or `test` as the CLI argument.
 
@@ -194,10 +194,10 @@ Misses            23        24          +1/+0
 
 # New misses
 =========================================================================
-Catalog                         15/38   (39.47%)  ->    15/39   (38.46%) 
+Catalog                         15/38   (39.47%)  ->    15/39   (38.46%)
 =========================================================================
-- jaffle_shop.customers          6/7    (85.71%)  ->     6/8    (75.00%) 
--- new_col                       -/-       (-)    ->     0/1     (0.00%) 
+- jaffle_shop.customers          6/7    (85.71%)  ->     6/8    (75.00%)
+-- new_col                       -/-       (-)    ->     0/1     (0.00%)
 =========================================================================
 ```
 
@@ -235,6 +235,23 @@ the support matrix.
 - [interrogate](https://interrogate.readthedocs.io/en/latest/) (docs coverage for Python)
 - [coverage.py](https://github.com/nedbat/coveragepy) (execution coverage for Python)
 
+## Contributing
+
+Clone this repo including submodules, create a virtual environment and install dependencies:
+```bash
+git clone --recurse-submodules [email protected]:slidoapp/dbt-coverage.git
+cd dbt-coverage
+pip install poetry
+poetry shell
+poetry install
+pre-commit install
+```
+
+To run all integration tests locally, run:
+```bash
+tox
+```
+
 ## License
 
 Licensed under the MIT license (see [LICENSE.md](LICENSE.md) file for more

dbt_coverage/__init__.py

@@ -6,11 +6,10 @@
 from dataclasses import dataclass, field, replace
 from enum import Enum
 from pathlib import Path
-from typing import Dict, Set, List, Optional
+from typing import Dict, List, Optional, Set
 
 import typer
 
-
 SUPPORTED_MANIFEST_SCHEMA_VERSIONS = [
     "https://schemas.getdbt.com/dbt/manifest/v4.json",
     "https://schemas.getdbt.com/dbt/manifest/v5.json",