Metadata-Version: 2.1
Name: dbt-coverage
Version: 0.1.1
Summary: A package for computing coverage of dbt-managed data warehouses
License: MIT
Author: Andrej Švec
Author-email: asvec@slido.com
Requires-Python: >=3.6,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: typer (>=0.4.0,<0.5.0)
Description-Content-Type: text/markdown

# dbt-coverage

A CLI library with Python backend for computing docs and test coverage of dbt
managed data warehouses.

## Installation

```
pip install dbt-coverage
```

## Usage

`dbt-coverage` comes with two basic commands: `compute` and `compare`. The
documentation for the individual commands can be shown by using the `--help`
option.

### Compute

Computes coverage from `target/catalog.json` and `target/manifest.json` files
found in a dbt project. You need to select documentation or test coverage by
using the respective CLI argument.

```
$ cd my-dbt-project
$ dbt docs generate  # Generate catalog.json and manifest.json
$ dbt-coverage compute doc  # Compute doc coverage, print it and write it to coverage.json file
$ dbt-coverage compute test  # Compute test coverage

# Coverage summary
# =======================================
# my-table-1               8/20     40.0%
# my-table-2              20/20    100.0%
# my-table-3               2/8      25.0%
# =======================================
# Total                   30/48     62.5%
```

### Compare

Compares two `coverage.json` files generated by the `compute` command.

```
$ dbt-coverage compare coverage-after.json coverage-before.json

# Coverage delta summary
#               before     after            +/-
# =============================================
# Coverage      62.50%    60.00%         -2.50%
# =============================================
# Tables             3         4          +1/+0
# Columns           48        50          +2/+0
# =============================================
# Hits              30        30          +0/+0
# Misses            18        20          +2/+0
# =============================================

# New misses
# Catalog                  30/48   (62.50%)  ->    30/50   (60.00%) 
# ==================================================================
# - my-table-4              -/-       (-)    ->     0/2     (0.00%) 
# -- my-column-1            -/-       (-)    ->     0/1     (0.00%) 
# -- my-column-2            -/-       (-)    ->     0/1     (0.00%) 
# ==================================================================
```

### Combined use-case

```
$ cd my-dbt-project

$ dbt docs generate  # Generate catalog.json and manifest.json
$ dbt-coverage compute doc --cov-report before.json --cov-fail-under 0.5 # Fail if coverage is lower than 50%

# Make changes to the dbt project, e.g. add some columns to the DWH, document some columns, etc.

$ dbt docs generate
$ dbt-coverage compute doc --cov-report after.json --cov-fail-compare before.json  # Fail if the current coverage is lower than coverage in before.json
$ dbt-coverage compare after.json before.json  # Generate a detailed coverage delta report
```

## Related packaged

https://github.com/mikaelene/dbt-test-coverage

## License

Licensed under the MIT license (see [LICENSE.md](LICENSE.md) file for more
details).
