tap-netlify

tap-netlify is a Singer tap for Netlify API.

This package is NOT officially supported by Netlify. Users are welcome to open issues or pull requests to improve the tap.

Extracts the following resources from Netlify API:

• sites
• builds
• deploys

Built with the Meltano SDK for Singer Taps.

Installation

pipx install  git+https://github.com/franloza/netlify-tap.git

Configuration

Accepted Config Options

The following configuration options are available:

• auth_token (required): User-generated token. See how to obtain it from the Netlify UI here
• user_agent (optional): It should be set to something that includes the name of your app, and a contact email address should the API provider need to contact you for any reason. Example

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

tap-netlify --about

Usage

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

Executing the Tap Directly

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

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

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

poetry run pytest

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

poetry run tap-netlify --help

SDK Dev Guide

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