tap-mode

tap-mode is a Singer tap for Mode API.

This package is NOT officially supported by Mode. Users are welcome to open issues or pull requests to improve the tap.

Extracts the following resources from Mode API:

Built with the Meltano SDK for Singer Taps.

Installation

pipx install  git+https://github.com/franloza/mode-tap.git

The following configuration options are available:

auth_token (required): The public component of the credential. See how to obtain it from Mode here
password (required): The private component of the credential. See how to obtain it from Mode here
workspace (required): Name of the Mode workspace
user_agent (optional): It should be set to something that includes the name of your app, and a contact email address should the API provider need to contact you for any reason.
start_date (optional): Fetch only entities created/updated after that date.

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

tap-mode --about

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

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

pipx install poetry
poetry install

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

poetry run pytest

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

poetry run tap-mode --help

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