tap-readme

Singer tap for ReadMe.com.

Built with the Meltano Singer SDK.

Capabilities

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

Settings

Setting	Required	Default	Description
api_key	True	None	API Key for ReadMe.com
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).
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

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

Supported Python Versions

• 3.9
• 3.10
• 3.11
• 3.12
• 3.13

Source Authentication and Authorization

Follow the official authentication instructions to get an API Key.

Usage

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

Executing the Tap Directly

tap-readme --version
tap-readme --help
tap-readme --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.

Your project comes with a custom meltano.yml project file already created. Go ahead and install Meltano if you haven't already.

1. Install all plugins

   meltano install

2. Check that the extractor is working properly

   meltano invoke tap-tap-readme --version

3. Execute an ELT pipeline

   meltano run tap-tap-readme 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.