tap-bls - Meltano Hub

Bureau of Labor Statistics

tap-bls (frasermarlow variant)🥈

US Government Labor Statistics

The tap-bls extractor pulls data from Bureau of Labor Statistics 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-bls extractor to your project using
```
meltano add
```
:

meltano add extractor tap-bls

Configure the tap-bls settings using

meltano config

:

meltano config tap-bls set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-bls 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-bls 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 tap-bls 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:

annualaverage
api-key
aspects
calculations
endyear
series_list_file_location
startyear

You can also list these settings using

meltano config

with the list subcommand:

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

Annual Average (annualaverage)

Environment variable: TAP_BLS_ANNUALAVERAGE

If selected, an annual data series will include a M13 datapoint with the annual average value. See the BLS website for more details.

Configure this setting directly using the following Meltano command:

meltano config tap-bls set annualaverage [value]

API Key (api-key)

Environment variable: TAP_BLS_API-KEY

Your BLS issued API key. It allows you to have less rate limiting issues.

Configure this setting directly using the following Meltano command:

meltano config tap-bls set api-key [value]

Aspects (aspects)

Environment variable: TAP_BLS_ASPECTS

An option you will find in the API documentation but setting this to 'true' has caused issues (in my experience) whereby some data points are no longer provided in the returning payload. Not many BLS series include this. See the BLS website for more details.

Configure this setting directly using the following Meltano command:

meltano config tap-bls set aspects [value]

Calculations (calculations)

Environment variable: TAP_BLS_CALCULATIONS

Provides 1,3,6 and 12 month changes in the data in both net and percentage format. If selected, these 6 additional datapoints will be included in separate columns. See the BLS website for more details.

Configure this setting directly using the following Meltano command:

meltano config tap-bls set calculations [value]

End Year (endyear)

Environment variable: TAP_BLS_ENDYEAR

The date you want the series to end. If left blank it will default to the current year.

Configure this setting directly using the following Meltano command:

meltano config tap-bls set endyear [value]

Series List File Location (series_list_file_location)

Environment variable: TAP_BLS_SERIES_LIST_FILE_LOCATION

An optional absolute or relative path to the series.json. If not provided (and if the schemas directory is empty), the tap will look for a file named series.json in the same location as the config.json file.

Configure this setting directly using the following Meltano command:

meltano config tap-bls set series_list_file_location [value]

Start Year (startyear)

Environment variable: TAP_BLS_STARTYEAR

the year you want your data extract to start. Not the limits: you can pull up to 20 years in one go, and most data seris start at 2000, so you do the math... If left blank it will default to 2000.

Configure this setting directly using the following Meltano command:

meltano config tap-bls set startyear [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-bls 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-bls

Maintenance Status

Repo

https://github.com/frasermarlow/tap-bls

Maintainer

Meltano Stats

Keywords