Skip to main content

Singer tap for CircleCI, built with the Meltano SDK for Singer Taps.

Project description

tap-circle-ci

tap-circle-ci is a Singer tap for CircleCI.

Built with the Meltano Tap SDK for Singer Taps.

Streams

WARNING: You must follow the projects in CircleCI to obtain their pipelines.

Installation

You can install this repository directly from the Github repo. For example, by running:

pipx install https://github.com/MeltanoLabs/tap-circle-ci.git

Configuration

Accepted Config Options

The following configuration options are available:

Field Description Type Required Default
token Personal API Token you have generated that can be used to access the CircleCI API string yes
org_slug Organization slug in the form vcs-slug/org-name. Example: org-slug=gh/CircleCI-Public string yes
user_agent User-Agent to make requests with string no tap-circle-ci/<version> Singer Tap for the CircleCI API
base_url Base URL for the CircleCI API string no https://circleci.com/api/v2

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

tap-circle-ci --about

Source Authentication and Authorization

Login to your Circle CI account, go to the Personal API Tokens page, and generate a new token.

Usage

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

Executing the Tap Directly

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

Developer Resources

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

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

poetry run pytest

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

poetry run tap-circle-ci --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-circle-ci
meltano install

Now you can test and orchestrate using Meltano:

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

meltano_tap_circle_ci-0.5.2.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

meltano_tap_circle_ci-0.5.2-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file meltano_tap_circle_ci-0.5.2.tar.gz.

File metadata

  • Download URL: meltano_tap_circle_ci-0.5.2.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for meltano_tap_circle_ci-0.5.2.tar.gz
Algorithm Hash digest
SHA256 92e7cc1f67953276d696f4424958b67bb8e368262ef46233fb4d1ab020156ede
MD5 57bb5bc07b9b5c6e2f312cbf9371646f
BLAKE2b-256 5c3d83561faa337d7db4213c02a26c6c47d9e19097009a4acb8f7e85be86e10c

See more details on using hashes here.

Provenance

The following attestation bundles were made for meltano_tap_circle_ci-0.5.2.tar.gz:

Publisher: release.yaml on MeltanoLabs/tap-circle-ci

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file meltano_tap_circle_ci-0.5.2-py3-none-any.whl.

File metadata

File hashes

Hashes for meltano_tap_circle_ci-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2195a217cb650a0f5a2860618b21a723e5401eaea3093097c7c9faf7a5c50f65
MD5 9fc5fe360ea9503d455febadba17a99c
BLAKE2b-256 551df00a67fb11ff732cb06a48f204bd0331b8b63ff977f903f333e8bd364f9b

See more details on using hashes here.

Provenance

The following attestation bundles were made for meltano_tap_circle_ci-0.5.2-py3-none-any.whl:

Publisher: release.yaml on MeltanoLabs/tap-circle-ci

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page