tap-geekbot

Singer tap for Geekbot.

Built with the Meltano Tap SDK for Singer Taps.

Capabilities

• catalog
• state
• discover
• about
• stream-maps

Settings

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

Source Authentication and Authorization

Setting	Required	Default	Description
api_key	True	None	API Key for Geekbot
start_date	False	None	Earliest datetime to get data from
stream_maps	False	None	Config object for stream maps capability. For more information check out Stream Maps.
stream_maps.else	False	None	Currently, only setting this to __NULL__ is supported. This will remove all other streams.
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 additional 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	Configuration for BATCH message capabilities.
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.

Usage

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

Executing the Tap Directly

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

Developer Resources

Initialize your Development Environment

uv sync

Create and Run Tests

Create tests within the tests subfolder and then run:

uv run pytest

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

uv run tap-geekbot --help

Testing with Meltano

Use Meltano to run an EL pipeline:

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