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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: meltano_tap_circle_ci-0.3.1.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for meltano_tap_circle_ci-0.3.1.tar.gz
Algorithm Hash digest
SHA256 634a5a93ebe608df1e9690e513e793fe39e0852b1f77583bf5301d4ac144baf1
MD5 63fa896bf15146c0c86d11414fd34bf3
BLAKE2b-256 c917ac0aa49996018614a5ebf9e1eb3491a9058df5637263f8a9b22a34f4fd22

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for meltano_tap_circle_ci-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0c3921c68a6d79cc718eb4f9818ea07e791919af42f337135c13f466aa8752db
MD5 4d5e6b0f2a103e3fbf188939bfe1e6f4
BLAKE2b-256 1278b36e0933de6ed144758155ec0e7216f091800e7335438f1bbebbc3d848e5

See more details on using hashes here.

Supported by

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