Skip to content

Tap for AWIN Publisher API using the Meltano SDK

License

Notifications You must be signed in to change notification settings

voxmedia/tap-awin

 
 

Repository files navigation

tap-awin

tap-awin is a Singer tap for Awin. The tap focuses on obtaining account information, then handling sub-streams according to account type.
Publishers can access streams:

  • Transactions
    Advertisers can access streams:
  • Transactions
  • Publishers

Built with the Meltano Tap SDK for Singer Taps.

Configuration

Accepted Config Options

  • Developer TODO: Provide a list of config options accepted by the tap.

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

tap-awin --about

Source Authentication and Authorization

  • Developer TODO: If your tap requires special access on the source system, or any special authentication requirements, provide those here.

Usage

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

Executing the Tap Directly

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

Developer Resources

  • Developer TODO: As a first step, scan the entire project for the text "TODO:" and complete any recommended steps, deleting the "TODO" references once completed.

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

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

poetry run pytest

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

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

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-awin --version
# OR run a test `elt` pipeline:
meltano elt tap-awin 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 AWIN Publisher API using the Meltano SDK

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 98.2%
  • Shell 1.8%