Skip to main content

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 test: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.5.2.tar.gz (15.2 kB view details)

Uploaded Source

Built Distribution

tap_shortcut-0.5.2-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file tap_shortcut-0.5.2.tar.gz.

File metadata

  • Download URL: tap_shortcut-0.5.2.tar.gz
  • Upload date:
  • Size: 15.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for tap_shortcut-0.5.2.tar.gz
Algorithm Hash digest
SHA256 a3e837548386a56cc5b652d3ccc4bd56b34bdeafd18f30d31d259a349ba6ef28
MD5 456742fd30a88e95a29fcc64fc98ef32
BLAKE2b-256 d20d9af524abbcc875c92f8fd485c6fb62e55604ede8d0119c9dbfa4a7f57c28

See more details on using hashes here.

Provenance

File details

Details for the file tap_shortcut-0.5.2-py3-none-any.whl.

File metadata

  • Download URL: tap_shortcut-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 14.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for tap_shortcut-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2a1edc66ff3e72a2afaf48c285b5659013cd8adb6e31c13ba5cbca25dac143c6
MD5 a195967512e3b274fe44c9f5c1117ece
BLAKE2b-256 50d0c0358930934afd642cba6b47b2e7313608b99ae12df0ce3d212b590b0ea8

See more details on using hashes here.

Provenance

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