tap-holidays - Meltano Hub

Holiday API

tap-holidays (goodeggs variant)🥈

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:

Installation and configuration

Add the tap-holidays extractor to your project using
```
meltano add
```
:

meltano add extractor tap-holidays

Configure the tap-holidays settings using

meltano config

meltano config tap-holidays set --interactive

Test that extractor settings are valid using

meltano config

meltano config tap-holidays test

Next 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-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:

api_key
api_version
streams.holidays.country
streams.holidays.year

You can also list these settings using

meltano config

with the list subcommand:

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

Configure this setting directly using the following Meltano command:

meltano config tap-holidays set api_key [value]

API Version (api_version)

Environment variable: TAP_HOLIDAYS_API_VERSION
Default Value: v1

The API version to use, default v1.

Configure this setting directly using the following Meltano command:

meltano config tap-holidays set api_version [value]

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

Environment variable: TAP_HOLIDAYS_STREAMS_HOLIDAYS_COUNTRY

The country code to request holidays for.

Configure this setting directly using the following Meltano command:

meltano config tap-holidays set streams holidays.country [value]

Year - Holiday Streams (streams.holidays.year)

Environment variable: TAP_HOLIDAYS_STREAMS_HOLIDAYS_YEAR

The year to request holidays for.

Configure this setting directly using the following Meltano command:

meltano config tap-holidays set streams holidays.year [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-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

Repo

https://github.com/goodeggs/tap-holidays

Maintainer

Keywords