Skip to content

Latest commit

 

History

History
150 lines (102 loc) · 4.26 KB

README.md

File metadata and controls

150 lines (102 loc) · 4.26 KB
Raw

tap-orca

tap-orca is a Singer tap for Orca.

Built with the Meltano Tap SDK for Singer Taps.

Install from GitHub:

pipx install git+https://github.com/jlloyd-widen/tap-orca.git@main

Configuration

Accepted Config Options

Setting Required Default Description
api_token True None The token to authenticate against the API service
custom_streams True None List of configs for custom streams.
stream_maps False None Config object for stream maps capability. For more information check out Stream Maps.
stream_map_config False None User-defined config values to be used within map expressions.
faker_config False None Config for the Faker instance variable fake used within map expressions. Only applicable if the plugin specifies faker as an addtional dependency (through the singer-sdk faker extra or directly).
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 for this tap is available by running:

tap-orca --about

Configure using environment variables

This Singer tap will automatically import any environment variables within the working directory's .env if the --config=ENV is provided, such that config values will be considered if a matching environment variable is set either in the terminal context or in the .env file.

Source Authentication and Authorization

Follow the instructions in the Orca API documentation to obtain an API token. You can only access the Orca documentation by logging into the Orca platform.

Usage

You can easily run tap-orca by itself or in a pipeline using Meltano.

Executing the Tap Directly

tap-orca --version
tap-orca --help
tap-orca --config CONFIG --discover > ./catalog.json

Developer Resources

Follow these instructions to contribute to this project.

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

Create tests within the tests subfolder and then run:

poetry run pytest

You can also test the tap-orca CLI interface directly using poetry run:

poetry run tap-orca --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.

Next, install Meltano (if you haven't already) and any needed plugins:

# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-orca
meltano install

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-orca --version
# OR run a test `elt` pipeline:
meltano elt tap-orca 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.