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

Install uv if you haven't already.

Create and Run Tests

Run integration tests:

uv run pytest

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

uv 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. Go ahead and install Meltano if you haven't already.

Install all plugins
```
meltano install
```
Check that the extractor is working properly
```
meltano invoke tap-shortcut --version
```
Execute an ELT pipeline
```
meltano run 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.