Forem

Meltano Community

tap-forem (reservoir-data variant)

Open source connector supported by the Meltano Community, a growing community of over 5500+ data engineers.

Open source Join Slack community

The tap-forem extractor pulls data from Forem 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-forem extractor to your project using 
    meltano add
     : 
    2. meltano add tap-forem
  2. Configure the tap-forem settings using 
    meltano config
     : 
    3. meltano config tap-forem set --interactive
  3. Test that extractor settings are valid using 
    meltano config
     : 
    4. meltano config tap-forem test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-forem 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
  • activate-version
  • batch
  • catalog
  • discover
  • schema-flattening
  • start-date
  • state
  • stream-maps
  • structured-logging

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-forem 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 

meltano config
with the list subcommand: 

meltano config tap-forem 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.

API Key (api_key)

  • Environment variable: TAP_FOREM_API_KEY

The Forem API key.


Configure this setting directly using the following Meltano command:

meltano config tap-forem set api_key [value]

API URL (api_url)

  • Environment variable: TAP_FOREM_API_URL
  • Default Value: https://dev.to/api/

The url for the API service.


Configure this setting directly using the following Meltano command:

meltano config tap-forem set api_url [value]

Emit `ACTIVATE_VERSION` messages (emit_activate_version_messages)

  • Environment variable: TAP_FOREM_EMIT_ACTIVATE_VERSION_MESSAGES
  • Default Value: false

Whether to emit ACTIVATE_VERSION messages. If set to True, the tap will emit ACTIVATE_VERSION messages for each stream.


Configure this setting directly using the following Meltano command:

meltano config tap-forem set emit_activate_version_messages [value]

Max Key Length (flattening_max_key_length)

  • Environment variable: TAP_FOREM_FLATTENING_MAX_KEY_LENGTH

The maximum length of a flattened key.


Configure this setting directly using the following Meltano command:

meltano config tap-forem set flattening_max_key_length [value]

Flattening Separator (flattening_separator)

  • Environment variable: TAP_FOREM_FLATTENING_SEPARATOR

The separator to use when flattening keys.


Configure this setting directly using the following Meltano command:

meltano config tap-forem set flattening_separator [value]

Start Date (start_date)

  • Environment variable: TAP_FOREM_START_DATE

The earliest record date to sync


Configure this setting directly using the following Meltano command:

meltano config tap-forem set start_date [value]

Tag (tag)

  • Environment variable: TAP_FOREM_TAG

Tag for filter articles by.


Configure this setting directly using the following Meltano command:

meltano config tap-forem set tag [value]
Expand To Show SDK Settings

Batch Compression Format (batch_config.encoding.compression)

  • Environment variable: TAP_FOREM_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-forem set batch_config encoding.compression [value]

Batch Encoding Format (batch_config.encoding.format)

  • Environment variable: TAP_FOREM_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-forem set batch_config encoding.format [value]

Batch Storage Prefix (batch_config.storage.prefix)

  • Environment variable: TAP_FOREM_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-forem set batch_config storage.prefix [value]

Batch Storage Root (batch_config.storage.root)

  • Environment variable: TAP_FOREM_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-forem set batch_config storage.root [value]

Faker Locale (faker_config.locale)

  • Environment variable: TAP_FOREM_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-forem set faker_config locale [value]

Faker Seed (faker_config.seed)

  • Environment variable: TAP_FOREM_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-forem set faker_config seed [value]

Enable Schema Flattening (flattening_enabled)

  • Environment variable: TAP_FOREM_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.


Configure this setting directly using the following Meltano command:

meltano config tap-forem set flattening_enabled [value]

Max Flattening Depth (flattening_max_depth)

  • Environment variable: TAP_FOREM_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-forem set flattening_max_depth [value]

User Stream Map Configuration (stream_map_config)

  • Environment variable: TAP_FOREM_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-forem set stream_map_config [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_FOREM_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-forem 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?

If you're having trouble getting the tap-forem 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.
Meltano Cloud

For ambitious analytics engineering teams that want an efficient, fully managed solution with personalised expert support, explore Meltano Cloud

  • No maintenance overhead
  • Rigorously tested
  • Expert support from Meltano
Learn more Book a demo

Install

meltano add tap-forem

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK

Repo

https://github.com/reservoir-data/tap-forem
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Edgar Ramírez

Keywords

  • meltano_sdk