Skip to content

Latest commit

 

History

History
157 lines (107 loc) · 3.56 KB

README.md

File metadata and controls

157 lines (107 loc) · 3.56 KB
Raw

tap-kustomer

tap-kustomer is a Singer tap for kustomer.

Built with the Meltano Tap SDK for Singer Taps.

Configuration

Accepted Config Options

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

tap-kustomer --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-kustomer by itself or in a pipeline using Meltano.

Executing the Tap Directly

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

poetry run pytest

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

poetry run tap-kustomer --help

Setting up a postgres container locally

Ensure Docker is running, then run these commands to create a postgres container locally:

docker run \
 --name dbt-postgres \
 --network host \
 -e POSTGRES_PASSWORD=postgres \
 -e POSTGRES_USER=postgres \
 -e POSTGRES_DB=postgres \
 -p 5432:5432 -d postgres

If using the devcontainer, add the following to your .secrets/.env file:

TARGET_POSTGRES_PASSWORD=postgres

If running it locally, you need to export it instead (OSX):

export TARGET_POSTGRES_PASSWORD=postgres

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-kustomer
meltano install

Now you can test and orchestrate using Meltano:

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