Feed

tap-feed (jawats variant)🥈

Generic tap for RSS and Atom feeds

The tap-feed extractor pulls data from Feed that can then be sent to a destination using a loader.

Alternate Implementations

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-feed extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-feed
  3. Configure the tap-feed settings using
    meltano config
    :
  4. meltano config tap-feed set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-feed test

Next steps

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

Capabilities

The current capabilities for tap-feed 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
  • 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-feed 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-feed 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.

Feed Entry Fields (feed_entry_fields)

  • Environment variable: TAP_FEED_FEED_ENTRY_FIELDS
  • Default Value: ["id","title","link"]

A list of entry level data fields to capture.


Configure this setting directly using the following Meltano command:

meltano config tap-feed set feed_entry_fields [value]

Feed Entry Replication Key (feed_entry_replication_key)

  • Environment variable: TAP_FEED_FEED_ENTRY_REPLICATION_KEY
  • Default Value: published

The field used to determine new records, typically 'published' or 'updated'.


Configure this setting directly using the following Meltano command:

meltano config tap-feed set feed_entry_replication_key [value]

Feed Fields (feed_fields)

  • Environment variable: TAP_FEED_FEED_FIELDS
  • Default Value: ["title"]

A list of feed level data fields to capture.


Configure this setting directly using the following Meltano command:

meltano config tap-feed set feed_fields [value]

Feed URLs (feed_urls)

  • Environment variable: TAP_FEED_FEED_URLS

A list of one or more feed paths.


Configure this setting directly using the following Meltano command:

meltano config tap-feed set feed_urls [value]

Start Date (start_date)

  • Environment variable: TAP_FEED_START_DATE

The earliest record date to sync


Configure this setting directly using the following Meltano command:

meltano config tap-feed set start_date [value]
Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

  • Environment variable: TAP_FEED_FLATTENING_ENABLED

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


Configure this setting directly using the following Meltano command:

meltano config tap-feed set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

  • Environment variable: TAP_FEED_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-feed set flattening_max_depth [value]

Stream Map Config (stream_map_config)

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

Stream Maps (stream_maps)

  • Environment variable: TAP_FEED_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-feed 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-feed 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.

Install

meltano add extractor tap-feed

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK

Repo

https://github.com/jawats/tap-feed
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Jon Watson

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

PyPI Stats

  • PyPI Downloads
  • PyPI Package Version

Keywords

  • apimeltano_sdk