tap-miro is a Singer tap for Miro.

Built with the Meltano Tap SDK for Singer Taps and the Miro API Reference

Miro tap class.

Built with the Meltano Singer SDK.

• catalog
• state
• discover
• about
• stream-maps
• schema-flattening

A full list of supported settings and capabilities for this tap is available by running:

tap-miro --about

Settings can be added on a per-stream basis and can be set using the stream_config setting. The stream_config setting takes a list of dictionaries, requiring the stream name as a value in the stream key. If the same stream name is added multiple times, only the last will be used.

Example:

{
    "stream_config": [
        {
            "stream": "STREAM_NAME",
            "parameters": "URL_QUERY_STRING"
        }
    ]
}

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-miro by itself or in a pipeline using Meltano.

tap-miro --version
tap-miro --help
tap-miro --config CONFIG --discover > ./catalog.json

Follow these instructions to contribute to this project.

pipx install poetry
poetry install

Create tests within the tap_miro/tests subfolder and then run:

poetry run pytest

You can also test the tap-miro CLI interface directly using poetry run:

poetry run tap-miro --help

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-miro
meltano install

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-miro --version
# OR run a test `elt` pipeline:
meltano elt tap-miro target-jsonl

See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.