WordPress.org

tap-wordpress-org (automattic variant)🥈

WordPress.org is the official repository for WordPress plugins, themes, and community resources, providing APIs to access comprehensive data about the WordPress ecosystem.

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

Next steps

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

Capabilities

The current capabilities for tap-wordpress-org 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
  • state
  • stream-maps

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

Settings

The tap-wordpress-org 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-wordpress-org 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 URL (api_url)

  • Environment variable: TAP_WORDPRESS_ORG_API_URL
  • Default Value: https://api.wordpress.org

The URL for the WordPress. Org API


Configure this setting directly using the following Meltano command:

meltano config tap-wordpress-org set api_url [value]

Events Ip (events_ip)

  • Environment variable: TAP_WORDPRESS_ORG_EVENTS_IP

IP address for events location detection


Configure this setting directly using the following Meltano command:

meltano config tap-wordpress-org set events_ip [value]

Events Location (events_location)

  • Environment variable: TAP_WORDPRESS_ORG_EVENTS_LOCATION

Location for events search (e.g., 'Seattle, WA')


Configure this setting directly using the following Meltano command:

meltano config tap-wordpress-org set events_location [value]

Request Delay (request_delay)

  • Environment variable: TAP_WORDPRESS_ORG_REQUEST_DELAY
  • Default Value: 0.1

Delay between API requests in seconds (default: 0.1)


Configure this setting directly using the following Meltano command:

meltano config tap-wordpress-org set request_delay [value]

Start Date (start_date)

  • Environment variable: TAP_WORDPRESS_ORG_START_DATE

Start date for incremental replication (plugins/themes)


Configure this setting directly using the following Meltano command:

meltano config tap-wordpress-org set start_date [value]

Stream Selection (stream_selection)

  • Environment variable: TAP_WORDPRESS_ORG_STREAM_SELECTION

List of stream names to sync (default: all streams)


Configure this setting directly using the following Meltano command:

meltano config tap-wordpress-org set stream_selection [value]

User Agent (user_agent)

  • Environment variable: TAP_WORDPRESS_ORG_USER_AGENT
  • Default Value: tap-wordpress-org/0.1.0

User agent for API requests


Configure this setting directly using the following Meltano command:

meltano config tap-wordpress-org set user_agent [value]
Expand To Show SDK Settings

Batch Compression Format (batch_config.encoding.compression)

  • Environment variable: TAP_WORDPRESS_ORG_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.


Configure this setting directly using the following Meltano command:

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

Batch Encoding Format (batch_config.encoding.format)

  • Environment variable: TAP_WORDPRESS_ORG_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.


Configure this setting directly using the following Meltano command:

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

Batch Storage Prefix (batch_config.storage.prefix)

  • Environment variable: TAP_WORDPRESS_ORG_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.


Configure this setting directly using the following Meltano command:

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

Batch Storage Root (batch_config.storage.root)

  • Environment variable: TAP_WORDPRESS_ORG_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.


Configure this setting directly using the following Meltano command:

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

Faker Locale (faker_config.locale)

  • Environment variable: TAP_WORDPRESS_ORG_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-wordpress-org set faker_config locale [value]

Faker Seed (faker_config.seed)

  • Environment variable: TAP_WORDPRESS_ORG_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-wordpress-org set faker_config seed [value]

Enable Schema Flattening (flattening_enabled)

  • Environment variable: TAP_WORDPRESS_ORG_FLATTENING_ENABLED

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


Configure this setting directly using the following Meltano command:

meltano config tap-wordpress-org set flattening_enabled [value]

Max Flattening Depth (flattening_max_depth)

  • Environment variable: TAP_WORDPRESS_ORG_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-wordpress-org set flattening_max_depth [value]

User Stream Map Configuration (stream_map_config)

  • Environment variable: TAP_WORDPRESS_ORG_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-wordpress-org set stream_map_config [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_WORDPRESS_ORG_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-wordpress-org 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-wordpress-org 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 tap-wordpress-org

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK

Repo

https://github.com/Automattic/tap-wordpress-org
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Automattic

Keywords

  • apimeltano_sdkwordpresspluginsthemesstatisticspatternsevents