The tap-readthedocs 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:
Installation and configuration
-
Add the tap-readthedocs extractor to your
project using
:meltano add -
Configure the tap-readthedocs
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add tap-readthedocsmeltano config tap-readthedocs set --interactivemeltano config tap-readthedocs testNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-readthedocs
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this extractor. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this extractor.
This plugin has the following capabilities:
- about
- batch
- catalog
- discover
- schema-flattening
- state
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-readthedocs settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-readthedocs list
You can
override these settings or specify additional ones
in your meltano.yml by adding the settings key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
Include Business Streams (include_business_streams)
-
Environment variable:
TAP_READTHEDOCS_INCLUDE_BUSINESS_STREAMS -
Default Value:
false
Whether to include streams available only to ReadTheDocs for Business accounts.
Configure this setting directly using the following Meltano command:
meltano config tap-readthedocs set include_business_streams [value]Token (token)
-
Environment variable:
TAP_READTHEDOCS_TOKEN
Personal Access Token that allows you to use the Read the Docs APIv3 being authenticated as yourself
Configure this setting directly using the following Meltano command:
meltano config tap-readthedocs set token [value]Expand To Show SDK Settings
Batch Compression Format (batch_config.encoding.compression)
-
Environment variable:
TAP_READTHEDOCS_BATCH_CONFIG_ENCODING_COMPRESSION
Compression format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-readthedocs set batch_config encoding.compression [value]Batch Encoding Format (batch_config.encoding.format)
-
Environment variable:
TAP_READTHEDOCS_BATCH_CONFIG_ENCODING_FORMAT
Format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-readthedocs set batch_config encoding.format [value]Batch Storage Prefix (batch_config.storage.prefix)
-
Environment variable:
TAP_READTHEDOCS_BATCH_CONFIG_STORAGE_PREFIX
Prefix to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-readthedocs set batch_config storage.prefix [value]Batch Storage Root (batch_config.storage.root)
-
Environment variable:
TAP_READTHEDOCS_BATCH_CONFIG_STORAGE_ROOT
Root path to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-readthedocs set batch_config storage.root [value]Faker Locale (faker_config.locale)
-
Environment variable:
TAP_READTHEDOCS_FAKER_CONFIG_LOCALE
One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization
Configure this setting directly using the following Meltano command:
meltano config tap-readthedocs set faker_config locale [value]Faker Seed (faker_config.seed)
-
Environment variable:
TAP_READTHEDOCS_FAKER_CONFIG_SEED
Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator
Configure this setting directly using the following Meltano command:
meltano config tap-readthedocs set faker_config seed [value]Enable Schema Flattening (flattening_enabled)
-
Environment variable:
TAP_READTHEDOCS_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-readthedocs set flattening_enabled [value]Max Flattening Depth (flattening_max_depth)
-
Environment variable:
TAP_READTHEDOCS_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-readthedocs set flattening_max_depth [value]User Stream Map Configuration (stream_map_config)
-
Environment variable:
TAP_READTHEDOCS_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config tap-readthedocs set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_READTHEDOCS_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config tap-readthedocs set stream_maps [value]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-brightgreen){kind=icon}
