tap-everflow

tap-everflow is a Singer tap for Everflow.

Built with the Meltano Tap SDK for Singer Taps.

Overview

tap-everflow extracts raw data from the Everflow Network API for the following resources:

• Offers
• Clicks
• Conversions

Installation

Install from GitHub:

# pip
pip install git+https://github.com/Matatika/tap-everflow

# pipx
pipx install git+https://github.com/Matatika/tap-everflow

# poetry
poetry add git+https://github.com/Matatika/tap-everflow

#uv
uv tool install git+https://github.com/Matatika/tap-everflow
uv pip install git+https://github.com/Matatika/tap-everflow

Configuration

Accepted Config Options

Name	Required	Default	Description
api_key	Yes		Everflow network API key
start_date	No	One year before the current date	The earliest record date to sync

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

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

Executing the Tap Directly

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

Developer Resources

Follow these instructions to contribute to this project.

Initialize your Development Environment

Prerequisites:

• Python 3.9+
• uv

uv sync

Create and Run Tests

Create tests within the tests subfolder and then run:

uv run pytest

You can also test the tap-everflow CLI interface directly using uv run:

uv run tap-everflow --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.

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

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

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-everflow --version

# OR run a test ELT pipeline:
meltano run tap-everflow 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.