tap-dbt-artifacts
is a Singer tap for dbt artifacts.
Built with the Meltano Tap SDK for Singer Taps.
Artifact | File Name | Schema | Description |
---|---|---|---|
Manifest | manifest.json | v12 | Representation of your dbt project's resources |
Run Results | run_results.json | v6 | Information about a completed invocation of dbt |
Catalog | catalog.json | v1 | Information from your data warehouse about the tables and views produced |
Sources | sources.json | v3 | Information about sources with freshness checks |
A full list of supported settings and capabilities for this tap is available by running:
tap-dbt-artifacts --about
This Singer tap will automatically import any environment variables within the working directory's
.env
if the --config=ENV
is provided, such that config values will be considered if a matching
environment variable is set either in the terminal context or in the .env
file.
You can easily run tap-dbt-artifacts
by itself or in a pipeline using Meltano.
tap-dbt-artifacts --version
tap-dbt-artifacts --help
tap-dbt-artifacts --config CONFIG --discover > ./catalog.json
Follow these instructions to contribute to this project.
Prerequisites:
- Python >=3.9, <3.13
- uv
uv sync
Create tests within the tests
subfolder and
then run:
uv run pytest
You can also test the tap-dbt-artifacts
CLI interface directly using uv run
:
uv run tap-dbt-artifacts --help
Testing with Meltano
Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.
Next, install Meltano (if you haven't already) and any needed plugins:
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-dbt-artifacts
meltano install
Now you can test and orchestrate using Meltano:
# Test invocation:
meltano invoke tap-dbt-artifacts --version
# OR run a test ELT pipeline:
meltano run tap-dbt-artifacts target-jsonl
See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.