tap-npm

tap-npm is a Singer tap for NPM.

Built with the Meltano Tap 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-npm

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-npm --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-npm by itself or in a pipeline using Meltano.

Executing the Tap Directly

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

Developer Resources

pipx install hatch

Create and Run Tests

Run integration tests:

hatch run test:integration

You can also test the tap-npm CLI interface directly:

hatch run sync:console -- --about --format=json

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. Install Meltano (if you haven't already) and any needed plugins:

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

Now you can test and orchestrate using Meltano:

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