tap-readthedocs 0.1.0

`tap-readthedocs` is a Singer tap for ReadTheDocs, built with the Meltano SDK for Singer Taps.

tap-readthedocs

Singer Tap for Read the Docs. Built with the Meltano Singer SDK.

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.