As a proof that this code works, see the data folder for artifacts generated with it.

tap-mailerlite

tap-mailerlite is a Singer tap for MailerLite.

Built with the Meltano Tap SDK for Singer Taps.

Installation

Install from GitHub:

pipx install git+https://github.com/butkeraites/tap-mailerlite.git@main

Configuration

Accepted Config Options

`tap-mailerlite`

MailerLite tap class.

Built with the Meltano Singer SDK.

Capabilities

catalog
state
discover
about
stream-maps
schema-flattening
batch

Settings

Setting	Required	Default	Description
auth_token	True	None	The token to authenticate against the API service
start_date	False	None	The earliest record date to sync
stream_maps	False	None	Config object for stream maps capability. For more information check out Stream Maps.
stream_map_config	False	None	User-defined config values to be used within map expressions.
faker_config	False	None	Config for the `Faker` instance variable `fake` used within map expressions. Only applicable if the plugin specifies `faker` as an addtional dependency (through the `singer-sdk` `faker` extra or directly).
faker_config.seed	False	None	Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator
faker_config.locale	False	None	One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization
flattening_enabled	False	None	'True' to enable schema flattening and automatically expand nested properties.
flattening_max_depth	False	None	The max depth to flatten schemas.
batch_config	False	None
batch_config.encoding	False	None	Specifies the format and compression of the batch files.
batch_config.encoding.format	False	None	Format to use for batch files.
batch_config.encoding.compression	False	None	Compression format to use for batch files.
batch_config.storage	False	None	Defines the storage layer to use when writing batch files
batch_config.storage.root	False	None	Root path to use when writing batch files.
batch_config.storage.prefix	False	None	Prefix to use when writing batch files.

A full list of supported settings and capabilities is available by running: tap-mailerlite --about

Supported Python Versions

3.8
3.9
3.10
3.11
3.12

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

tap-mailerlite --about

Source Authentication and Authorization

Create a config.json file at the root of the repository with the following structure:

{
    "auth_token": <Bearer token provided by Mailer Lite>
}

Usage

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

Executing the Tap Directly

tap-mailerlite --version
tap-mailerlite --help
tap-mailerlite --config config.json --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 tests subfolder and then run:

poetry run pytest

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

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

Now you can test and orchestrate using Meltano:

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