Holiday API

tap-holidays from goodeggs

Public Holiday and Observance API

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

Next steps

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

Capabilities

The current capabilities for tap-holidays 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:

  • catalog
  • discover
  • state

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

Settings

The streams.holidays.<> configurations have additional optional request parameters that can be set, see the API docs for more details. For example, meltano config tap-holidays set streams.holidays.public True will retrieve only public holidays. Also be aware that currently the free tier includes only last year holidays.

The tap-holidays 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 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_HOLIDAYS_API_KEY

A valid Holiday API key.

API Version (api_version)

  • Environment variable: TAP_HOLIDAYS_API_VERSION
  • Default Value: v1

The API version to use, default v1.

Country Code - Holiday Streams (streams.holidays.country)

  • Environment variable: TAP_HOLIDAYS_STREAMS_HOLIDAYS_COUNTRY

The country code to request holidays for.

Year - Holiday Streams (streams.holidays.year)

  • Environment variable: TAP_HOLIDAYS_STREAMS_HOLIDAYS_YEAR

The year to request holidays for.

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-holidays 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-holidays

Maintenance Status

  • Maintenance Status
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Georgi Yolovski

Meltano Stats

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

Keywords

  • api