Skip to content

GtheSheep/tap-emarsys

Repository files navigation

tap-emarsys

tap-emarsys is a Singer tap for Emarsys.

Built with the Meltano Tap SDK for Singer Taps.

Installation

pipx install git+https://github.com/gthesheep/tap-emarsys

Configuration

Accepted Config Options

username - Username for your Emarsys API user secret - Secret for your Emarsys API user language_id - Identifier of the language for your account, i.e. en (default)

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

tap-emarsys --about

Source Authentication and Authorization

See the Emarsys docs for details on how to obtain authentication credentials

Usage

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

Executing the Tap Directly

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

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

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

poetry run pytest

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

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

Your project comes with a custom meltano.yml project file already created. Open the meltano.yml and follow any "TODO" items listed in the file.

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

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

Now you can test and orchestrate using Meltano:

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

About

Tap for the Emarsys API built using the Meltano SDK

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published