tap-openweathermap - Meltano Hub

OpenWeatherMap

tap-openweathermap (matatika variant)🥇

Current and Forecast Weather Data Collection

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

Alternate Implementations

Airbyte
🥉
Matatika (default)🥇

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

Installation and configuration

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

meltano add tap-openweathermap

Configure the tap-openweathermap settings using

meltano config

:

meltano config tap-openweathermap set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-openweathermap 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-openweathermap 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-openweathermap 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
current_weather_city_name
forecast_weather_lattitude
forecast_weather_longitude
weather_units

Expand To Show SDK Settings

batch_config.encoding.compression
batch_config.encoding.format
batch_config.storage.prefix
batch_config.storage.root
faker_config.locale
faker_config.seed
flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

You can also list these settings using

meltano config

with the list subcommand:

meltano config tap-openweathermap 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_OPENWEATHERMAP_API_KEY

API Key is a required parameter to query the api endpoints

Configure this setting directly using the following Meltano command:

meltano config tap-openweathermap set api_key [value]

Current Weather City Name (current_weather_city_name)

Environment variable: TAP_OPENWEATHERMAP_CURRENT_WEATHER_CITY_NAME

City name that you want to get weather for

Configure this setting directly using the following Meltano command:

meltano config tap-openweathermap set current_weather_city_name [value]

Forecast Weather Lattitude (forecast_weather_lattitude)

Environment variable: TAP_OPENWEATHERMAP_FORECAST_WEATHER_LATTITUDE

Lattitude of city to get forecast for

Configure this setting directly using the following Meltano command:

meltano config tap-openweathermap set forecast_weather_lattitude [value]

Forecast Weather Longitude (forecast_weather_longitude)

Environment variable: TAP_OPENWEATHERMAP_FORECAST_WEATHER_LONGITUDE

Longitude of city to get forecast for

Configure this setting directly using the following Meltano command:

meltano config tap-openweathermap set forecast_weather_longitude [value]

Weather Units (weather_units)

Environment variable: TAP_OPENWEATHERMAP_WEATHER_UNITS

Units to use: standard (default), metric or imperial

Configure this setting directly using the following Meltano command:

meltano config tap-openweathermap set weather_units [value]

Expand To Show SDK Settings

Batch Compression Format (batch_config.encoding.compression)

Environment variable: TAP_OPENWEATHERMAP_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.

Configure this setting directly using the following Meltano command:

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

Batch Encoding Format (batch_config.encoding.format)

Environment variable: TAP_OPENWEATHERMAP_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.

Configure this setting directly using the following Meltano command:

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

Batch Storage Prefix (batch_config.storage.prefix)

Environment variable: TAP_OPENWEATHERMAP_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.

Configure this setting directly using the following Meltano command:

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

Batch Storage Root (batch_config.storage.root)

Environment variable: TAP_OPENWEATHERMAP_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.

Configure this setting directly using the following Meltano command:

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

Faker Locale (faker_config.locale)

Environment variable: TAP_OPENWEATHERMAP_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-openweathermap set faker_config locale [value]

Faker Seed (faker_config.seed)

Environment variable: TAP_OPENWEATHERMAP_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-openweathermap set faker_config seed [value]

Enable Schema Flattening (flattening_enabled)

Environment variable: TAP_OPENWEATHERMAP_FLATTENING_ENABLED

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

Configure this setting directly using the following Meltano command:

meltano config tap-openweathermap set flattening_enabled [value]

Max Flattening Depth (flattening_max_depth)

Environment variable: TAP_OPENWEATHERMAP_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-openweathermap set flattening_max_depth [value]

User Stream Map Configuration (stream_map_config)

Environment variable: TAP_OPENWEATHERMAP_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-openweathermap set stream_map_config [value]

Stream Maps (stream_maps)

Environment variable: TAP_OPENWEATHERMAP_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-openweathermap 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-openweathermap 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-openweathermap

Maintenance Status

Repo

https://github.com/Matatika/tap-openweathermap

Maintainer

Meltano Stats

Keywords