Skip to content

Latest commit

 

History

History
103 lines (69 loc) · 2.96 KB

README.md

File metadata and controls

103 lines (69 loc) · 2.96 KB
Raw

tap-pypi-singer

tap-pypi-singer is a Singer tap for retrieving the plugins supported by Meltano via the MeltanoHub API then retrieving usage stats for their pypi packages using https://pepy.tech/ website's API. The pepy website returns unaggregated download counts split by version so this tap aggregates up to total, day, week, and month level without considering the package version.

Built with the Meltano SDK 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.
pipx install tap-pypi-singer

Configuration

Accepted Config Options

  • Developer TODO: Provide a list of config options accepted by the tap.

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

tap-pypi-singer --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.

Usage

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

Executing the Tap Directly

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

Developer Resources

  • Developer TODO: As a first step, scan the entire project for the text "TODO:" and complete any recommended steps, deleting the "TODO" references once completed.

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

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

poetry run pytest

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

poetry run tap-pypi-singer --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.

Your project comes with a custom meltano.yml project file already created. Open the meltano.yml and follow any "TODO" items listed in the file.

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

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

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-pypi-singer --version
# OR run a test `elt` pipeline:
meltano elt tap-pypi-singer 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.