Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edgarrmondragon/tap-shortcut
Singer tap for Shortcut
https://github.com/edgarrmondragon/tap-shortcut
meltano-sdk project-management singer-io singer-tap
Last synced: 4 months ago
JSON representation
Singer tap for Shortcut
- Host: GitHub
- URL: https://github.com/edgarrmondragon/tap-shortcut
- Owner: edgarrmondragon
- License: apache-2.0
- Created: 2022-01-06T08:31:11.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T15:37:01.000Z (4 months ago)
- Last Synced: 2024-10-03T01:05:51.427Z (4 months ago)
- Topics: meltano-sdk, project-management, singer-io, singer-tap
- Language: Python
- Homepage: https://pypi.org/p/tap-shortcut
- Size: 439 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tap-shortcut
Singer tap for Shortcut. Built with the [Meltano Tap SDK](https://sdk.meltano.com) 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](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-shortcut --version
tap-shortcut --help
tap-shortcut --config CONFIG --discover > ./catalog.json
```
## Developer Resources
### Initialize your Development Environment
```bash
pipx install hatch
```
### Create and Run Tests
Run integration tests:
```bash
hatch run test:integration
```
You can also test the `tap-shortcut` CLI interface directly:
```bash
hatch run sync:console -- --about --format=json
```
### Testing with [Meltano](https://www.meltano.com)
_**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](https://docs.meltano.com/getting-started/installation/) if you haven't already.
1. Install all plugins
```bash
meltano install
```
1. Check that the extractor is working properly
```bash
meltano invoke tap-shortcut --version
```
1. Execute an ELT pipeline
```bash
meltano run tap-shortcut target-jsonl
```
### SDK Dev Guide
See the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to
develop your own taps and targets.