search

edgarrmondragon / tap-readthedocs

A singer.io tap for readthedocs.io, bult with the Meltano SDK
https://pypi.org/p/tap-readthedocs
Apache License 2.0
1 stars 0 forks source link
meltano-sdk readthedocs singer-io singer-tap

readme

# tap-readthedocs
pre-commit.ci status Ruff Hatch project License PyPI
Singer Tap for [**Read the Docs**](https://docs.readthedocs.io). Built with the [Meltano Singer SDK](https://sdk.meltano.com).

Capabilities

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.

  1. Install all plugins

    meltano install

  2. Check that the extractor is working properly

    meltano invoke tap-readthedocs --version

  3. 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.