/tap-hightouch

Singer tap for Hightouch.io that leverages the Meltano SDK for Singer

Primary LanguagePythonMIT LicenseMIT

tap-hightouch

tap-hightouch is a Singer tap for Hightouch.io.

Built with the Meltano SDK for Singer Taps.

Installation

To install this tap, run:

pip install git+https://github.com/immuta/tap-hightouch.git

Configuration

Accepted Config Options

Config options include:

  • api_key: Hightouch API key
  • sync_id_list: A list of integer values for the syncs to export data from

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

tap-hightouch --about

Usage

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

Executing the Tap Directly

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

Developer Resources

Below are instructions for working on this package.

Initialize your Development Environment

First install the package using poetry. Refer to that package's installation instructions.

poetry install

Create and Run Tests

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

poetry run pytest

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

poetry run tap-hightouch --help

SDK Dev Guide

See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.