`tap-readthedocs` is a Singer tap for ReadTheDocs, built with the Meltano SDK for Singer Taps.
Project description
tap-readthedocs
Singer tap for readthedocs.io.
Built with the Meltano SDK for Singer Taps and Targets.
Capabilities
catalog
state
discover
about
stream-maps
Settings
Setting | Required | Default | Description |
---|---|---|---|
token | True | None |
A full list of supported settings and capabilities is available by running: tap-readthedocs --about
Installation
pipx install git+https://github.com/edgarrmondragon/tap-readthedocs.git
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 poetry
poetry install
Create and Run Tests
Create tests within the tests
folder and then run:
poetry run pytest
You can also test the tap-readthedocs
CLI interface directly using poetry run
:
poetry run tap-readthedocs --help
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.
Next, install Meltano (if you haven't already) and any needed plugins:
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-readthedocs
meltano install
Now you can test and orchestrate using Meltano:
# Test invocation:
meltano invoke tap-readthedocs --version
# OR run a test `elt` pipeline:
meltano elt 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.0.1a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca85a6dcdf08083e7fe3d4ccbb673260314dc7fcaead83395c719a6de3ccc7e7 |
|
MD5 | e1f31c30b6184602c148a1a29b2795e8 |
|
BLAKE2b-256 | dded1dbb3e044085b9c440fd70cbf3ef663d3ba637bbd89582c5f4f24acf9b5c |