`tap-readthedocs` is a Singer tap for ReadTheDocs, built with the Meltano SDK for Singer Taps.
Project description
Capabilities
catalog
state
discover
about
stream-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 tests: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
Hashes for tap_readthedocs-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ad89535e315e140f7844d263d8244ad70cc3ffd613f69c6b76c69a75005d584 |
|
MD5 | 18a01775a46f5f91bb3c0746aa7a36a0 |
|
BLAKE2b-256 | e0d7468ec0b3c2dd209af700895ef3fd90d22d570ea1db22674d8de2c99f3d2a |