Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/yu-iskw/dbt-artifacts-parser

A dbt artifacts parser in python
https://github.com/yu-iskw/dbt-artifacts-parser
dbt dbt-artifacts parser pypi-package python python-package
Last synced: 13 days ago
JSON representation
A dbt artifacts parser in python
Host: GitHub
URL: https://github.com/yu-iskw/dbt-artifacts-parser
Owner: yu-iskw
License: apache-2.0
Created: 2022-03-01T05:15:31.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-10-04T00:58:49.000Z (about 1 month ago)
Last Synced: 2024-10-04T11:59:27.962Z (about 1 month ago)
Topics: dbt, dbt-artifacts, parser, pypi-package, python, python-package
Language: Python
Homepage: https://pypi.org/project/dbt-artifacts-parser/
Size: 890 KB
Stars: 65
Watchers: 4
Forks: 16
Open Issues: 7
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project

awesome-dbt - dbt-artifacts-parser - It enables us to deal with catalog.json, manifest.json, run-results.json and sources.json as python objects. (Utilities)
README

        [![Test python](https://github.com/yu-iskw/dbt-artifacts-parser/actions/workflows/test.yml/badge.svg)](https://github.com/yu-iskw/dbt-artifacts-parser/actions/workflows/test.yml)













# dbt-artifacts-parser

This is a dbt artifacts parse in python.

It enables us to deal with `catalog.json`, `manifest.json`, `run-results.json` and `sources.json` as python objects.

This package is primarily designed for dbt-core, enabling seamless interaction with dbt artifacts as Python objects. While dbt Cloud provides additional artifact types beyond those of dbt-core, this package does not offer comprehensive support for them.

## Supported Versions and Compatibility

> **⚠️ Important Note:**

>

> - **Pydantic v1 will not be supported for dbt 1.9 or later.**

> - **To parse dbt 1.9 or later, please migrate your code to pydantic v2.**

> - **We will reassess version compatibility upon the release of pydantic v3.**

| Version | Supported dbt Version | Supported pydantic Version |

|---------|-----------------------|----------------------------|

|  0.7    | dbt 1.5 to 1.8        | pydantic v2                |

|  0.6    | dbt 1.5 to 1.8        | pydantic v1                |

|  0.5    | dbt 1.5 to 1.7        | pydantic v1                |

## Installation

```bash

pip install -U dbt-artifacts-parser

```

## Python classes

Those are the classes to parse dbt artifacts.

### Catalog

- [CatalogV1](dbt_artifacts_parser/parsers/catalog/catalog_v1.py) for catalog.json v1

### Manifest

- [ManifestV1](dbt_artifacts_parser/parsers/manifest/manifest_v1.py) for manifest.json v1

- [ManifestV2](dbt_artifacts_parser/parsers/manifest/manifest_v2.py) for manifest.json v2

- [ManifestV3](dbt_artifacts_parser/parsers/manifest/manifest_v3.py) for manifest.json v3

- [ManifestV4](dbt_artifacts_parser/parsers/manifest/manifest_v4.py) for manifest.json v4

- [ManifestV5](dbt_artifacts_parser/parsers/manifest/manifest_v5.py) for manifest.json v5

- [ManifestV6](dbt_artifacts_parser/parsers/manifest/manifest_v6.py) for manifest.json v6

- [ManifestV7](dbt_artifacts_parser/parsers/manifest/manifest_v7.py) for manifest.json v7

- [ManifestV8](dbt_artifacts_parser/parsers/manifest/manifest_v8.py) for manifest.json v8

- [ManifestV9](dbt_artifacts_parser/parsers/manifest/manifest_v9.py) for manifest.json v9

- [ManifestV10](dbt_artifacts_parser/parsers/manifest/manifest_v10.py) for manifest.json v10

- [ManifestV11](dbt_artifacts_parser/parsers/manifest/manifest_v11.py) for manifest.json v11

- [ManifestV12](dbt_artifacts_parser/parsers/manifest/manifest_v12.py) for manifest.json v12

### Run Results

- [RunResultsV1](dbt_artifacts_parser/parsers/manifest/manifest_v1.py) for run_results.json v1

- [RunResultsV2](dbt_artifacts_parser/parsers/manifest/manifest_v2.py) for run_results.json v2

- [RunResultsV3](dbt_artifacts_parser/parsers/manifest/manifest_v3.py) for run_results.json v3

- [RunResultsV4](dbt_artifacts_parser/parsers/manifest/manifest_v4.py) for run_results.json v4

- [RunResultsV5](dbt_artifacts_parser/parsers/manifest/manifest_v5.py) for run_results.json v5

- [RunResultsV6](dbt_artifacts_parser/parsers/manifest/manifest_v6.py) for run_results.json v6

### Sources

- [SourcesV1](dbt_artifacts_parser/parsers/sources/sources_v1.py) for sources.json v1

- [SourcesV2](dbt_artifacts_parser/parsers/sources/sources_v2.py) for sources.json v2

- [SourcesV3](dbt_artifacts_parser/parsers/sources/sources_v3.py) for sources.json v3

## Examples

### Parse catalog.json

```python

import json

# parse any version of catalog.json

from dbt_artifacts_parser.parser import parse_catalog

with open("path/to/catalog.json", "r") as fp:

    catalog_dict = json.load(fp)

    catalog_obj = parse_catalog(catalog=catalog_dict)

# parse catalog.json v1

from dbt_artifacts_parser.parser import parse_catalog_v1

with open("path/to/catalog.json", "r") as fp:

    catalog_dict = json.load(fp)

    catalog_obj = parse_catalog_v1(catalog=catalog_dict)

```

### Parse manifest.json

```python

import json

# parse any version of manifest.json

from dbt_artifacts_parser.parser import parse_manifest

with open("path/to/manifest.json", "r") as fp:

    manifest_dict = json.load(fp)

    manifest_obj = parse_manifest(manifest=manifest_dict)

# parse manifest.json v1

from dbt_artifacts_parser.parser import parse_manifest_v1

with open("path/to/manifest.json", "r") as fp:

    manifest_dict = json.load(fp)

    manifest_obj = parse_manifest_v1(manifest=manifest_dict)

# parse manifest.json v2

from dbt_artifacts_parser.parser import parse_manifest_v2

with open("path/to/manifest.json", "r") as fp:

    manifest_dict = json.load(fp)

    manifest_obj = parse_manifest_v2(manifest=manifest_dict)

# parse manifest.json v3

from dbt_artifacts_parser.parser import parse_manifest_v3

with open("path/to/manifest.json", "r") as fp:

    manifest_dict = json.load(fp)

    manifest_obj = parse_manifest_v3(manifest=manifest_dict)

# parse manifest.json v4

from dbt_artifacts_parser.parser import parse_manifest_v4

with open("path/to/manifest.json", "r") as fp:

    manifest_dict = json.load(fp)

    manifest_obj = parse_manifest_v4(manifest=manifest_dict)

# parse manifest.json v5

from dbt_artifacts_parser.parser import parse_manifest_v5

with open("path/to/manifest.json", "r") as fp:

    manifest_dict = json.load(fp)

    manifest_obj = parse_manifest_v5(manifest=manifest_dict)

# parse manifest.json v6

from dbt_artifacts_parser.parser import parse_manifest_v6

with open("path/to/manifest.json", "r") as fp:

    manifest_dict = json.load(fp)

    manifest_obj = parse_manifest_v6(manifest=manifest_dict)

# parse manifest.json v7

from dbt_artifacts_parser.parser import parse_manifest_v7

with open("path/to/manifest.json", "r") as fp:

    manifest_dict = json.load(fp)

    manifest_obj = parse_manifest_v7(manifest=manifest_dict)

# parse manifest.json v8

from dbt_artifacts_parser.parser import parse_manifest_v8

with open("path/to/manifest.json", "r") as fp:

    manifest_dict = json.load(fp)

    manifest_obj = parse_manifest_v8(manifest=manifest_dict)

# parse manifest.json v9

from dbt_artifacts_parser.parser import parse_manifest_v9

with open("path/to/manifest.json", "r") as fp:

    manifest_dict = json.load(fp)

    manifest_obj = parse_manifest_v9(manifest=manifest_dict)

# parse manifest.json v10

from dbt_artifacts_parser.parser import parse_manifest_v10

with open("path/to/manifest.json", "r") as fp:

    manifest_dict = json.load(fp)

    manifest_obj = parse_manifest_v10(manifest=manifest_dict)

# parse manifest.json v11

from dbt_artifacts_parser.parser import parse_manifest_v11

with open("path/to/manifest.json", "r") as fp:

    manifest_dict = json.load(fp)

    manifest_obj = parse_manifest_v11(manifest=manifest_dict)

# parse manifest.json v12

from dbt_artifacts_parser.parser import parse_manifest_v12

with open("path/to/manifest.json", "r") as fp:

    manifest_dict = json.load(fp)

    manifest_obj = parse_manifest_v12(manifest=manifest_dict)

```

### Parse run-results.json

```python

import json

# parse any version of run-results.json

from dbt_artifacts_parser.parser import parse_run_results

with open("path/to/run-resultsjson", "r") as fp:

    run_results_dict = json.load(fp)

    run_results_obj = parse_run_results(run_results=run_results_dict)

# parse run-results.json v1

from dbt_artifacts_parser.parser import parse_run_results_v1

with open("path/to/run-results.json", "r") as fp:

    run_results_dict = json.load(fp)

    run_results_obj = parse_run_results_v1(run_results=run_results_dict)

# parse run-results.json v2

from dbt_artifacts_parser.parser import parse_run_results_v2

with open("path/to/run-results.json", "r") as fp:

    run_results_dict = json.load(fp)

    run_results_obj = parse_run_results_v2(run_results=run_results_dict)

# parse run-results.json v3

from dbt_artifacts_parser.parser import parse_run_results_v3

with open("path/to/run-results.json", "r") as fp:

    run_results_dict = json.load(fp)

    run_results_obj = parse_run_results_v3(run_results=run_results_dict)

# parse run-results.json v4

from dbt_artifacts_parser.parser import parse_run_results_v4

with open("path/to/run-results.json", "r") as fp:

    run_results_dict = json.load(fp)

    run_results_obj = parse_run_results_v4(run_results=run_results_dict)

# parse run-results.json v5

from dbt_artifacts_parser.parser import parse_run_results_v5

with open("path/to/run-results.json", "r") as fp:

    run_results_dict = json.load(fp)

    run_results_obj = parse_run_results_v5(run_results=run_results_dict)

# parse run-results.json v6

from dbt_artifacts_parser.parser import parse_run_results_v6

with open("path/to/run-results.json", "r") as fp:

    run_results_dict = json.load(fp)

    run_results_obj = parse_run_results_v6(run_results=run_results_dict)

```

### Parse sources.json

```python

import json

# parse any version of sources.json

from dbt_artifacts_parser.parser import parse_sources

with open("path/to/sources.json", "r") as fp:

    sources_dict = json.load(fp)

    sources_obj = parse_sources(sources=sources_dict)

# parse sources.json v1

from dbt_artifacts_parser.parser import parse_sources_v1

with open("path/to/sources.json", "r") as fp:

    sources_dict = json.load(fp)

    sources_obj = parse_sources_v1(sources=sources_dict)

# parse sources.json v2

from dbt_artifacts_parser.parser import parse_sources_v2

with open("path/to/sources.json", "r") as fp:

    sources_dict = json.load(fp)

    sources_obj = parse_sources_v2(sources=sources_dict)

# parse sources.json v3

from dbt_artifacts_parser.parser import parse_sources_v3

with open("path/to/sources.json", "r") as fp:

    sources_dict = json.load(fp)

    sources_obj = parse_sources_v3(sources=sources_dict)

```

## Contributors

Thank you for your contributions!

If you are interested in contributing to this package, please check out the [CONTRIBUTING.md](./CONTRIBUTING.md).

 

  

            

                

                    

                    


                    _{Yu Ishikawa}

                

            

            

                

                    

                    


                    _Null

                

            

            

                

                    

                    


                    _{Brent Brewington}

                

            

            

                

                    

                    


                    _{Judah Rand}

                

            

            

                

                    

                    


                    _{Mohamed Nabil Mahmoud Hafez}

                

            

            

                

                    

                    


                    _{Onkar Ravgan}

                

            

  

  

            

                

                    

                    


                    _Null