Skip to content

Latest commit

 

History

History
130 lines (89 loc) · 3.86 KB

README.md

File metadata and controls

130 lines (89 loc) · 3.86 KB
Raw

tap-gainsightpx

tap-gainsightpx is a Singer tap for GainsightPX.

Built with the Meltano Tap SDK for Singer Taps.

Installation

Install from PyPi:

pipx install tap-gainsightpx

Install from GitHub:

pipx install git+https://github.com/Widen/tap-gainsightpx.git@main

Configuration

Accepted Config Options

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

tap-gainsightpx --about
Setting Required Default Description
api_url False https://api.aptrinsic.com/v1 The base url for GainsightPX service. See GainsightPX docs.
api_key True None The api key to authenticate against the GainsightPX service
page_size False 500 The number of records to return from the API in single page.Default and Max is 500.
start_date False 2022-10-26T00:00:00Z The earliest record date to sync (inclusive '>='). ISO Format
end_date False 2022-10-27T00:00:00Z The latest record date to sync (inclusive '<='). ISO format.
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.

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

See the GainsightPX documentation for how to create an API key and find your base url.

Usage

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

Executing the Tap Directly

tap-gainsightpx --version
tap-gainsightpx --help
tap-gainsightpx --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 tap_gainsightpx/tests subfolder and then run:

poetry run pytest

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

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

Now you can test and orchestrate using Meltano:

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