The tap-readthedocs Meltano extractor pulls data from Read the Docs that can then be sent to a destination using a loader.

Getting Started #

Prerequisites #

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration #

  1. Add the tap-readthedocs extractor to your project using meltano add :

    meltano add extractor tap-readthedocs
  2. Configure the settings below using meltano config .

Next steps #

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline
If you run into any issues, learn how to get help.

Capabilities #

Settings #

The settings for extractor tap-readthedocs that are known to Meltano are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

API Token (token) #

Personal Access Token that allows you to use the Read the Docs APIv3 being authenticated as yourself

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-readthedocs set token <token>

export TAP_READTHEDOCS_TOKEN=<token>

Looking for help? #

If you're having trouble getting the tap-readthedocs extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!