`tap-readme` is a Singer tap for ReadMe.com, built with the Meltano SDK for Singer Taps.
Project description
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.8
- 3.9
- 3.10
- 3.11
- 3.12
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
pipx install hatch
Create and Run Tests
Run integration tests:
hatch run tests:integration
You can also test the tap-tap-readme
CLI interface directly:
hatch run sync:console -- --about --format=json
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.
-
Install all plugins
meltano install
-
Check that the extractor is working properly
meltano invoke tap-tap-readme --version
-
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for tap_readme-0.0.1a5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 481acb40222966cf0eb43bbc1d43f26e91b2136bed64b22a020b7be5d51d44aa |
|
MD5 | 4523e0aa59b161c05861b24f719c3447 |
|
BLAKE2b-256 | 29567981c77b27e25377c2ef172666fa858a6f68d2c36c203609adff654d8c26 |