Skip to content

Latest commit

 

History

History
149 lines (104 loc) · 4.5 KB

README.md

File metadata and controls

149 lines (104 loc) · 4.5 KB
Raw

tap-gladly

tap-gladly is a Singer tap for Gladly and the Export API

Built with the Meltano Tap SDK for Singer Taps.

Capabilities

  • catalog
  • state
  • discover
  • about
  • stream-maps
  • schema-flattening

Settings

Setting Required Default Description
username True None The username to authenticate against the API service
password True None The username to authenticate against the API service
project_ids False None Project IDs to replicate
start_date True None The earliest job date to sync, parsed with "pendulum.parse"
end_date False None The latest job date to sync, parsed with "pendulum.parse"
max_job_lookback False None Maximmum lookback in time to try fetch files generated by export jobs from.If start_date is earlier than (now - start_date), the tap does not try to fetch the export files as it assumes they do not exist.
api_url_base True None The url for the API service
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.
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.

A full list of supported settings and capabilities is available by running: tap-gladly --about

Configuration

Accepted Config Options

A full list of supported settings and capabilities for this tap is available by running:

tap-gladly --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

Usage

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

Executing the Tap Directly

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

Developer Resources

Follow these instructions to contribute to this project.

Initialize your Development Environment

pipx install poetry
poetry config virtualenvs.in-project true # Optional, to create a virtual env
poetry install

Create and Run Tests

Create tests within the tap_gladly/tests subfolder and then run:

poetry run pytest

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

poetry run tap-gladly --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-gladly
meltano install

Now you can test and orchestrate using Meltano:

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