Skip to content

MeltanoLabs/evidence-ext

Repository files navigation

evidence-ext

Ruff pre-commit.ci status

evidence-ext is A Meltano utility extension for Evidence.dev 📊

Testing with Meltano

This extension includes a sample Evidence project, along with a meltano.yml project file, allowing you to test Evidence with Meltano.

# install Meltano
pipx install meltano
# install the Meltano project locally
meltano install
# run evidence in dev mode
meltano invoke evidence dev
# build the example evidence project
meltano invoke evidence build

Upgrading Evidence Versions

From time to time you may need to upgrade the version of an evidence project.

# install latest version of evidence
meltano invoke evidence upgrade
# run arbitrary npm commands for evidence
meltano invoke evidence npm {args}

Installing this extension for local development

  1. Install the project dependencies with poetry install:
cd path/to/your/project
poetry install
  1. Verify that you can invoke the extension:
poetry run evidence_extension --help
poetry run evidence_extension describe --format=yaml
poetry run evidence_invoker --help # if you have are wrapping another tool

Template updates

This project was generated with copier from the Meltano EDK template. Answers to the questions asked during the generation process are stored in the .copier_answers.yml file.

Removing this file can potentially cause unwanted changes to the project if the supplied answers differ from the original when using copier update.