tap-readme
Singer tap for ReadMe.com.
Built with the Meltano Singer SDK.
Capabilities
catalogstatediscoveraboutstream-mapsschema-flatteningbatch
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.10
- 3.11
- 3.12
- 3.13
- 3.14
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.
-
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.
Metadata
Release files for tap-readme 0.3.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| tap_readme-0.3.7.tar.gz | 75.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| tap_readme-0.3.7-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 85.5 kB
Release files / tap_readme-0.3.7.tar.gz
| Download URL | tap_readme-0.3.7.tar.gz |
|---|---|
| Size | 75.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3f88277b9a1c7e2af2caa97614dc385b89c8c35c32748a151df9e15d6a6c4ebe
|
|
BLAKE2b-256 checksum How to use checksums |
206128a319bfb50c18000917c49f15b8d0395a08634616eb30d9a0249a560c2f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 25, 2025.
Transparency logRelease files / tap_readme-0.3.7-py3-none-any.whl
| Download URL | tap_readme-0.3.7-py3-none-any.whl |
|---|---|
| Size | 9.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
78174497b17d39328d13562d8dcc981374aefe4ad23d17429ceb496fe77f5e8e
|
|
BLAKE2b-256 checksum How to use checksums |
d0c6bddb5ed6a729ab8c4cfa5a22fa2f2da0315652b382a774ed73a57955bfef
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 25, 2025.
Transparency log
