evidence-ext


Nameevidence-ext JSON
Version 0.7.0 PyPI version JSON
download
home_page
Summary`evidence-ext` is a Meltano utility extension.
upload_time2024-01-10 23:17:59
maintainer
docs_urlNone
authorMeltano
requires_python>=3.8,<4
licenseApache-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # evidence-ext

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/MeltanoLabs/evidence-ext/main.svg)](https://results.pre-commit.ci/latest/github/MeltanoLabs/evidence-ext/main)

`evidence-ext` is A Meltano utility extension for [Evidence.dev](https://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.

```shell
# 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.

```shell
# 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`:

```shell
cd path/to/your/project
poetry install
```

2. Verify that you can invoke the extension:

```shell
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](https://copier.readthedocs.io/en/stable/) from the [Meltano EDK template](https://github.com/meltano/edk).
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`.


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "evidence-ext",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4",
    "maintainer_email": "",
    "keywords": "",
    "author": "Meltano",
    "author_email": "hello@meltano.com",
    "download_url": "https://files.pythonhosted.org/packages/9a/b7/696e1d5a63fcd891250a703cae0679619d90402950f69adb7912a92fb706/evidence_ext-0.7.0.tar.gz",
    "platform": null,
    "description": "# evidence-ext\n\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/MeltanoLabs/evidence-ext/main.svg)](https://results.pre-commit.ci/latest/github/MeltanoLabs/evidence-ext/main)\n\n`evidence-ext` is A Meltano utility extension for [Evidence.dev](https://evidence.dev) \ud83d\udcca\n\n## Testing with Meltano\n\nThis extension includes a sample Evidence project, along with a `meltano.yml` project file, allowing you to test Evidence with Meltano.\n\n```shell\n# install Meltano\npipx install meltano\n# install the Meltano project locally\nmeltano install\n# run evidence in dev mode\nmeltano invoke evidence dev\n# build the example evidence project\nmeltano invoke evidence build\n```\n\n## Upgrading Evidence Versions\n\nFrom time to time you may need to upgrade the version of an evidence project.\n\n```shell\n# install latest version of evidence\nmeltano invoke evidence upgrade\n# run arbitrary npm commands for evidence\nmeltano invoke evidence npm {args}\n```\n\n## Installing this extension for local development\n\n1. Install the project dependencies with `poetry install`:\n\n```shell\ncd path/to/your/project\npoetry install\n```\n\n2. Verify that you can invoke the extension:\n\n```shell\npoetry run evidence_extension --help\npoetry run evidence_extension describe --format=yaml\npoetry run evidence_invoker --help # if you have are wrapping another tool\n```\n\n## Template updates\n\nThis project was generated with [copier](https://copier.readthedocs.io/en/stable/) from the [Meltano EDK template](https://github.com/meltano/edk).\nAnswers to the questions asked during the generation process are stored in the `.copier_answers.yml` file.\n\nRemoving this file can potentially cause unwanted changes to the project if the supplied answers differ from the original when using `copier update`.\n\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "`evidence-ext` is a Meltano utility extension.",
    "version": "0.7.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3727286c09a8207340758c81cc87fcb98c75b16a9762488f0471f29a394b746c",
                "md5": "7a7e44047a3902519e6bb8c77840d4fd",
                "sha256": "ec0da15ec785b44ae5e3bd5eb79f95a66576e786a218e14ebb993739098fc8e1"
            },
            "downloads": -1,
            "filename": "evidence_ext-0.7.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7a7e44047a3902519e6bb8c77840d4fd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4",
            "size": 8033,
            "upload_time": "2024-01-10T23:17:57",
            "upload_time_iso_8601": "2024-01-10T23:17:57.449448Z",
            "url": "https://files.pythonhosted.org/packages/37/27/286c09a8207340758c81cc87fcb98c75b16a9762488f0471f29a394b746c/evidence_ext-0.7.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9ab7696e1d5a63fcd891250a703cae0679619d90402950f69adb7912a92fb706",
                "md5": "8e47365accc40ec986ae9185f60d7a6e",
                "sha256": "40be380a55f4b585392983c8b8e4894b9b3b5baa3c79e8e45612b36fd5d15c5c"
            },
            "downloads": -1,
            "filename": "evidence_ext-0.7.0.tar.gz",
            "has_sig": false,
            "md5_digest": "8e47365accc40ec986ae9185f60d7a6e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4",
            "size": 6644,
            "upload_time": "2024-01-10T23:17:59",
            "upload_time_iso_8601": "2024-01-10T23:17:59.093024Z",
            "url": "https://files.pythonhosted.org/packages/9a/b7/696e1d5a63fcd891250a703cae0679619d90402950f69adb7912a92fb706/evidence_ext-0.7.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-10 23:17:59",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "evidence-ext"
}
        
Elapsed time: 0.16535s