tap-nhl

tap-nhl is a Singer tap for the NHL Stats API.

Built with the Meltano Tap SDK for Singer Taps.

Flow diagram

flowchart TD
Root[NHL Stats API] -->|Year| Seasons[Seasons]
Root[NHL Stats API] --> Conferences[Conferences]
Root[NHL Stats API] --> Divisions[Divisions]
Root[NHL Stats API] -->|Year| Draft[Draft]
Seasons[Seasons] -->|Season| Schedule[Schedule]
Seasons[Seasons] --> |Season| Teams[Teams]
Schedule[Schedule] -->|Game PK| Shifts[Shifts]
Schedule[Schedule] -->|Game PK| Game[Game]
Game[Game] -->|Game PK| Plays[Live Feed Plays]
Game[Game] -->|Game PK| Linescore[Live Feed Linescore]
Game[Game] -->|Game PK| Boxscore[Live Feed Boxscore]
Teams[Teams] --> |Roster| Player[Players]
Draft[Draft] -->|Prospect ID| Prospects[Prospects]

Installation

pipx install git+https://github.com/the-data-base/tap-nhl.git

Configuration

Accepted Config Options

A full list of supported settings and capabilities for this tap is available by running:

tap-nhl --about

Usage

You can easily run tap-nhl by itself or in a pipeline using Meltano.

Executing the Tap Directly

tap-nhl --version
tap-nhl --help
tap-nhl --config CONFIG --discover > ./catalog.json

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

Create tests within the tap_nhl/tests subfolder and then run:

poetry run pytest

You can also test the tap-nhl CLI interface directly using poetry run:

poetry run tap-nhl --help

Testing with Meltano

Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.

Next, install Meltano (if you haven't already) and any needed plugins:

# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-nhl
meltano install

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-nhl --version
# OR run a test `elt` pipeline:
meltano elt tap-nhl target-jsonl

SDK Dev Guide

See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.

drwggm / tap-nhl