https://github.com/reservoir-data/tap-hookdeck
Singer tap for Hookdeck
https://github.com/reservoir-data/tap-hookdeck
meltano singer-sdk singer-tap
Last synced: 2 months ago
JSON representation
Singer tap for Hookdeck
- Host: GitHub
- URL: https://github.com/reservoir-data/tap-hookdeck
- Owner: reservoir-data
- License: apache-2.0
- Created: 2023-12-19T17:48:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-12T00:40:26.000Z (2 months ago)
- Last Synced: 2025-02-12T01:33:58.479Z (2 months ago)
- Topics: meltano, singer-sdk, singer-tap
- Language: Python
- Homepage:
- Size: 355 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# `tap-hookdeck`
Singer tap for Hookdeck.
Built with the [Meltano Singer SDK](https://sdk.meltano.com).
## Capabilities
* `catalog`
* `state`
* `discover`
* `about`
* `stream-maps`
* `schema-flattening`
* `batch`
## Settings
| Setting | Required | Default | Description |
|:--------------------|:--------:|:-------:|:------------|
| api_key | True | None | API Key for Hookdeck |
| start_date | False | None | Earliest datetime to get data from |
| stream_maps | False | None | Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html). |
| stream_map_config | False | None | User-defined config values to be used within map expressions. |
| flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |
| flattening_max_depth| False | None | The max depth to flatten schemas. |
| batch_config | False | None | |
A full list of supported settings and capabilities is available by running: `tap-hookdeck --about`
## Supported Python Versions
* 3.9
* 3.10
* 3.11
* 3.12
* 3.13
### Source Authentication and Authorization
See https://hookdeck.com/docs/api#authentication.
## Usage
You can easily run `tap-hookdeck` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-hookdeck --version
tap-hookdeck --help
tap-hookdeck --config CONFIG --discover > ./catalog.json
```
## Developer Resources
### Initialize your Development Environment
```bash
uv tool install --with tox-uv tox
```
### Create and Run Tests
Run all tests:
```bash
tox run-parallel
```
### 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
```
2. Check that the extractor is working properly
```bash
meltano invoke tap-hookdeck --version
```
3. Execute an ELT pipeline
```bash
meltano run tap-hookdeck 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.