artefacts 1.0.0a2

Deserialization for dbt artifacts

artefacts

A deserialization library for dbt artifacts.

Usage

The simplest way to use artefacts is by importing the api.

>>> import artefacts.api

The api provides convenient methods for interacting with your dbt project's compiled artifacts.

artefacts.api.models()

>>> models = artefacts.api.models()
>>> len(models) > 0
True

artefacts.api.tests()

>>> tests = artefacts.api.tests()
>>> len(tests) > 0
True

Development Setup

Open this repository in a Github Codespace. (Click the green Code button in the repository's Github page and select New Codespace).

Testing

poetry run pytest

By default, pytest will test against the dbt project located at DBT_PROJECT_DIR. To test against a different dbt project, update that environment variable and build the project.

export DBT_PROJECT_DIR=$PWD/dbt_projects/dbt-starter-project
poetry run dbt build --project-dir $DBT_PROJECT_DIR
poetry run pytest