Metadata-Version: 2.1
Name: dbt-metrics-converter
Version: 0.1.3b1
Summary: Easily convert out of date, or unsported metrics spec into the latest suported metrics spec in dbt
Author: Jordan Stein
Author-email: jordan.stein77@gmail.com
Requires-Python: >=3.9,<3.10
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: click (>=8.1.3,<9.0.0)
Requires-Dist: dbt-core (>=1.5.0,<2.0.0)
Requires-Dist: dbt-semantic-interfaces (==0.1.0.dev4)
Requires-Dist: metricflow (==0.200.0.dev4)
Description-Content-Type: text/markdown

The dbt converter is a CLI tool that simplifies the process of migrating from the metrics spec supported in dbt v1.5 and earlier to the metrics specification supported in dbt ≥v1.6.

**Installing dbt converter**

```sql
pip install dbt-converter
```

**Upgrading to dbt v1.6 spec**

1. Navigate to the root of your dbt project.
2. Install the `dbt-converter` package using pip. Note that the converter requires `dbt-core==1.5`. You may need to update the version range for the `dbt_metrics` package.
3. Run `dc convert-metrics`. The converter assumes you are in the root of your dbt project. Optionally, you can pass the project path `-dbt-project-path path/to/dbt_project`. NOTE: All metrics must have a timestamp for the upgrade to run. If your metrics do not have a timestamp, add one before running the converter.
4. Semantic models and metrics files will be created in the `semantic_models` and `metrics` directories. Move these folders into your model path.
5. Delete the `metrics` package, move the old metrics configs out of your model path, or delete them.

**Testing your metrics in dbt v1.6**

1. Upgrade to dbt v1.6, and `pip install dbt-metricflow`
2. Remove the old metrics package from your `dbt_packages` and run `dbt clean && dbt deps`. 
3. Run `dbt parse` to generate a semantic manifest
4. View the metrics in your dbt project by running `mf list metrics`
5. Run `mf validate-configs —skip-dw` to validate metrics configs. 
6. To run a test query, run `mf query --metrics <metric_name>`

**Gotchas:**

- Some packages, like fivetran/ad_reporting have metrics defined in them using the v1.5 spec, this may cause an error if you try to run your project after upgrading to v1.6
- Make sure to delete any calls of `metrics.calculate` or `metrics.develop` they won’t work without the dbt_metrics package
