Singer tap for ReadTheDocs, built with the Meltano SDK for Singer Taps.
Project description
Capabilities
catalogstatediscoveraboutstream-maps
Settings
| Setting | Required | Default | Description |
|---|---|---|---|
| token | True | None | |
| include_business_streams | False | False | Whether to include streams available only to ReadTheDocs for Business accounts |
A full list of supported settings and capabilities is available by running: tap-readthedocs --about
Installation
pipx install tap-readthedocs
Source Authentication and Authorization
Generate a token: https://readthedocs.org/accounts/tokens/.
Usage
You can easily run tap-readthedocs by itself or in a pipeline using Meltano.
Executing the Tap Directly
tap-readthedocs --version
tap-readthedocs --help
tap-readthedocs --config CONFIG --discover > ./catalog.json
Developer Resources
Initialize your Development Environment
pipx install hatch
Create and Run Tests
Run integration tests:
hatch run test:integration
You can also test the tap-readthedocs 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-readthedocs --version
-
Execute an ELT pipeline
meltano run tap-readthedocs 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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tap_readthedocs-0.5.18.tar.gz.
File metadata
- Download URL: tap_readthedocs-0.5.18.tar.gz
- Upload date:
- Size: 54.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9bca7362d706407538ab6cddc8c8e4c00f3370517fa1516a47b952fee0484960
|
|
| MD5 |
010ed93d9ee7ff795aab0368919e17ee
|
|
| BLAKE2b-256 |
d65ec406f0f2f308e514d9c1567b154a53b2f20a28a879d3ef1b019f4d8c2e05
|
Provenance
The following attestation bundles were made for tap_readthedocs-0.5.18.tar.gz:
Publisher:
release.yaml on reservoir-data/tap-readthedocs
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
tap_readthedocs-0.5.18.tar.gz -
Subject digest:
9bca7362d706407538ab6cddc8c8e4c00f3370517fa1516a47b952fee0484960 - Sigstore transparency entry: 935528055
- Sigstore integration time:
-
Permalink:
reservoir-data/tap-readthedocs@2586a9c9bd38786f40c221406bb870338e216072 -
Branch / Tag:
refs/tags/v0.5.18 - Owner: https://github.com/reservoir-data
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@2586a9c9bd38786f40c221406bb870338e216072 -
Trigger Event:
push
-
Statement type:
File details
Details for the file tap_readthedocs-0.5.18-py3-none-any.whl.
File metadata
- Download URL: tap_readthedocs-0.5.18-py3-none-any.whl
- Upload date:
- Size: 10.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
63d1152ac5fa057dc705c5793b20174f0340e5c3f73b216500cbc0bdfdb8d917
|
|
| MD5 |
0b6eb88d8f2b879785046152c4eee4bb
|
|
| BLAKE2b-256 |
169461b0eb6c8e46a602383e65758df3c5175d4f2f2816d0aa1d39ef06d9d2cb
|
Provenance
The following attestation bundles were made for tap_readthedocs-0.5.18-py3-none-any.whl:
Publisher:
release.yaml on reservoir-data/tap-readthedocs
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
tap_readthedocs-0.5.18-py3-none-any.whl -
Subject digest:
63d1152ac5fa057dc705c5793b20174f0340e5c3f73b216500cbc0bdfdb8d917 - Sigstore transparency entry: 935528102
- Sigstore integration time:
-
Permalink:
reservoir-data/tap-readthedocs@2586a9c9bd38786f40c221406bb870338e216072 -
Branch / Tag:
refs/tags/v0.5.18 - Owner: https://github.com/reservoir-data
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@2586a9c9bd38786f40c221406bb870338e216072 -
Trigger Event:
push
-
Statement type:
