Skip to main content

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:

uv tool 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

curl -LsSf https://astral.sh/uv/install.sh | sh  # https://docs.astral.sh/uv/getting-started/installation/
uv sync

Create and Run Tests

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

uv run pytest

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

uv 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
uv tool 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 run 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.

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.6.6.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

meltano_tap_circle_ci-0.6.6-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: meltano_tap_circle_ci-0.6.6.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for meltano_tap_circle_ci-0.6.6.tar.gz
Algorithm Hash digest
SHA256 034f0410065544b6dd7c876f09980c358c884a1428fbfded2489c6e7c8288617
MD5 5f276b7827c86fad0ad155e93ab3042e
BLAKE2b-256 5b86cfcb8a36d0e8ab4dfc89531e0d987ba6940ed2b2d457d163f262f234afb0

See more details on using hashes here.

Provenance

The following attestation bundles were made for meltano_tap_circle_ci-0.6.6.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.6.6-py3-none-any.whl.

File metadata

File hashes

Hashes for meltano_tap_circle_ci-0.6.6-py3-none-any.whl
Algorithm Hash digest
SHA256 7fcb6008a6ec9623fc812e75c31d6a146164959db63c3380c06da49f3dbe2b61
MD5 3ca94460fd2a24abb6ec5a1488df33c3
BLAKE2b-256 cde0c890373cc4cc14f18699e1e57a5ab3d59b064aa7bf14156e045b52209938

See more details on using hashes here.

Provenance

The following attestation bundles were made for meltano_tap_circle_ci-0.6.6-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 Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page