tap-shortcut 0.1.0

`tap-shortcut` is a Singer tap for Shortcut, built with the Meltano SDK for Singer Taps.

tap-shortcut

Singer tap for Shortcut. Built with the Meltano Tap SDK for Singer Taps.

Capabilities

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

Settings

Setting	Required	Default	Description
token	True	None	Shortcut Token

A full list of supported settings and capabilities is available by running: tap-shortcut --about

Source Authentication and Authorization

See https://developer.shortcut.com/api/rest/v3#Authentication.

Usage

You can easily run tap-shortcut by itself or in a pipeline using Meltano.

Executing the Tap Directly

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

Developer Resources

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

Create tests within the tests subfolder and then run:

poetry run pytest

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

poetry run tap-shortcut --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.

Your project comes with a custom meltano.yml project file already created. Open the meltano.yml and follow any "TODO" items listed in the file.

Next, install Meltano (if you haven't already) and any needed plugins:

# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-shortcut
meltano install

Now you can test and orchestrate using Meltano:

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

SDK Dev Guide

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