Skip to content

Commit

Permalink
Updated readme, removed TODOs
Browse files Browse the repository at this point in the history
  • Loading branch information
DanielPDWalker committed Oct 21, 2021
1 parent 55ecae0 commit b9909ee
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 7 deletions.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,28 @@ Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.

## Installation

- [ ] `Developer TODO:` Update the below as needed to correctly describe the install procedure. For instance, if you do not have a PyPi repo, or if you want users to directly install from your git repo, you can modify this step as appropriate.

```bash
pipx install tap-openweathermap
```

## Configuration

```bash
TAP_OPENWEATHERMAP_API_KEY=1234567890
TAP_OPENWEATHERMAP_CURRENT_WEATHER_CITY_NAME=london
TAP_OPENWEATHERMAP_FORECAST_WEATHER_LONGITUDE=-0.1257
TAP_OPENWEATHERMAP_FORECAST_WEATHER_LATTITUDE=51.5085
```

`api_key` is required for authentication, see the "Source Authentication and Authorization" section for how to get one.
`current_weather_city_name` is required, and the api will return current weather data for the supplied city name.

`forecast_weather_longitude` is optional, you need to provide this to get forecast data.
`forecast_weather_lattitude` is optional, you need to provide this to get forecast data.

You can get the longitude and lattitude of a city by requesting its current weather, setting the city name to the ``current_weather_city_name` setting.
The longitude and lattidue will be returned as part of the curren

### Accepted Config Options

- [ ] `Developer TODO:` Provide a list of config options accepted by the tap.
Expand All @@ -27,8 +41,11 @@ tap-openweathermap --about

### Source Authentication and Authorization

- [ ] `Developer TODO:` If your tap requires special access on the source system, or any special authentication requirements, provide those here.
To use this tap you require an API key from [https://openweathermap.org/])(https://openweathermap.org/).

Sign up for a free account and under your profile you will find your default API Key.

The API Key is required to be passed as a parameter to the API the authenticate your request.

## Usage

Expand Down
5 changes: 1 addition & 4 deletions tap_openweathermap/tap.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,11 @@
from singer_sdk import Tap, Stream
from singer_sdk import typing as th # JSON schema typing helpers

# TODO: Import your custom stream types here:
from tap_openweathermap.streams import (
CurrentWeatherStream,
ForecastWeatherStream,
)
# TODO: Compile a list of custom stream types here
# OR rewrite discover_streams() below with your custom logic.

STREAM_TYPES = [
CurrentWeatherStream,
ForecastWeatherStream,
Expand All @@ -21,7 +19,6 @@ class TapOpenWeatherMap(Tap):
"""OpenWeatherMap tap class."""
name = "tap-openweathermap"

# TODO: Update this section with the actual config values you expect:
config_jsonschema = th.PropertiesList(
th.Property(
"api_key",
Expand Down

0 comments on commit b9909ee

Please sign in to comment.