Skip to main content

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

Project description

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 hatch

Create and Run Tests

Run integration tests:

hatch run tests:integration

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

hatch run sync:console -- --about --format=json

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.

  1. Install all plugins

    meltano install
    
  2. Check that the extractor is working properly

    meltano invoke tap-shortcut --version
    
  3. 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tap_shortcut-0.4.0a1.tar.gz (15.4 kB view hashes)

Uploaded Source

Built Distribution

tap_shortcut-0.4.0a1-py3-none-any.whl (14.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page