tap-polarsh

Singer tap for Polar.sh.

Built with the Meltano Tap SDK for Singer Taps.

Capabilities

• catalog
• state
• discover
• about
• stream-maps
• schema-flattening
• batch

Settings

Setting	Required	Default	Description
token	True	None	API Token for Polar
is_member	False	true	Whether to only query organizations the user is a member of. Defaults to True.
start_date	False	None	Earliest datetime to get data from

Built-in Singer SDK Settings

Setting	Required	Default	Description
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-polarsh --about

Source Authentication and Authorization

Get a Personal Access Token and provide it as the token setting.

Supported Python Versions

• 3.10
• 3.11
• 3.12
• 3.13
• 3.14

Installation

In a Meltano project

Using a direct reference

meltano add extractor tap-polarsh --from-ref=https://raw.githubusercontent.com/reservoir-data/tap-polarsh/main/plugin.yaml

Requires Meltano v3.1.0+.

From MeltanoHub

Not yet available.

From PyPI

Not yet available.

With pipx

pipx install git+https://github.com/reservoir-data/tap-polarsh.git@main

Usage

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

Executing the Tap Directly

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

Developer Resources

Initialize your Development Environment

uv tool install --with tox-uv tox

Create and Run Tests

Run all tests:

tox run-parallel

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.

Use Meltano to run an EL pipeline:

uvx meltano invoke tap-polarsh --version
uvx meltano run tap-polarsh 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.