Skip to main content

pipeline-analytics-sdk-python

CI PyPI Codecov License: MIT docs

A Python client for pipeline-analytics's REST API, generated from its OpenAPI spec with openapi-python-client. It saves you from hand-rolling HTTP requests, retries and pagination against the API yourself.

Requirements

  • Python 3.12 or later.
  • A running pipeline-analytics instance.
  • A session cookie for that instance (see "Authentication" below) — every endpoint except get_version and the two webhook receivers needs one.

Installation

pip install pipeline-analytics-sdk

Pin an exact version in your own pyproject.toml/requirements.txt rather than tracking the latest release in anything but a quick trial.

Authentication

pipeline-analytics authenticates browsers with WebAuthn, not an API token — there's no headless credential-grant flow in its spec (a token flow is a known gap on the server side), so this SDK can't log in for you. Get a session cookie by logging into the dashboard in a browser, opening dev tools, and copying the session cookie's value. Pass it to PipelineAnalyticsClient or set PIPELINE_ANALYTICS_SESSION in the environment:

import os
from pipeline_analytics import PipelineAnalyticsClient

client = PipelineAnalyticsClient(
    "https://pipeline-analytics.example.com",
    session_cookie=os.environ.get("PIPELINE_ANALYTICS_SESSION"),
)

A session cookie expires the same way it would in a browser; there's nothing in this SDK to refresh it automatically.

Usage

get_version needs no session and is a good first call to prove the client reaches the server at all:

from pipeline_analytics import PipelineAnalyticsClient

with PipelineAnalyticsClient("https://pipeline-analytics.example.com") as client:
    version = client.get_version()
    print("server version:", version.version)

Listing tracked repos needs a session, and demonstrates the pagination iterator and error handling:

import os
from pipeline_analytics import APIError, PipelineAnalyticsClient, iter_repos

client = PipelineAnalyticsClient(
    "https://pipeline-analytics.example.com",
    session_cookie=os.environ.get("PIPELINE_ANALYTICS_SESSION"),
)

try:
    for repo in iter_repos(client.raw):
        print(repo.identifier, repo.ingestion_status)
except APIError as e:
    if e.status_code == 401:
        raise SystemExit("session cookie expired or invalid") from e
    raise

An async equivalent, aiter_repos, is available for async/await code.

Every other operation follows the generated client's pattern — pipeline_analytics._generated.api.<tag>.<operation>.sync_detailed(client=client.raw, ...) (or asyncio_detailed for async) returns a typed Response whose .parsed field holds the decoded body for a documented status code. Use decode_error to turn any error response into a pipeline_analytics.APIError uniformly:

from pipeline_analytics import decode_error
from pipeline_analytics._generated.api.repos import get_repo_usage

response = get_repo_usage.sync_detailed(client=client.raw, repo_id=repo_id)
if error := decode_error(response):
    raise error
usage = response.parsed

The client retries a 429 or 5xx response with exponential backoff and jitter (honoring a server-sent Retry-After), and never retries any other 4xx. Tune it by passing a pipeline_analytics.RetryConfig as retry=, or swap the underlying httpx.Client/httpx.AsyncClient entirely with httpx_client=/httpx_async_client=.

Reports

The last green run on main publishes its test and coverage reports at apis.ryankes.eu/pipeline-analytics-sdk-python/reports/: JUnit XML under tests/, and an HTML report plus Cobertura coverage.xml under coverage/. A red test run publishes nothing.

Regenerating the client

See CONTRIBUTING.md — the generated code is pinned to a specific pipeline-analytics commit and shouldn't drift from it silently.

Contributing

See CONTRIBUTING.md for building, testing and the release process.

License

MIT — a permissive license for the client, independent of pipeline-analytics' own AGPL-3.0.

Metadata

Release files for pipeline-analytics-sdk 3.0.15

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pipeline-analytics-sdk 3.0.15
File Size Uploaded Provenance Actions
pipeline_analytics_sdk-3.0.15.tar.gz 241.3 kB With provenance Details for pipeline_analytics_sdk-3.0.15.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pipeline-analytics-sdk 3.0.15
File Interpreter ABI Platform Actions
pipeline_analytics_sdk-3.0.15-py3-none-any.whl Python 3 none any Details for pipeline_analytics_sdk-3.0.15-py3-none-any.whl

Total release size: 394.8 kB

Release files / pipeline_analytics_sdk-3.0.15.tar.gz

Download URL pipeline_analytics_sdk-3.0.15.tar.gz
Size 241.3 kB
Tags Source
SHA-256 checksum
How to use checksums
8bff93f3ed21ad8d7a3521b49595c8f5bccee682d0b63051f0c72740d59933ff
BLAKE2b-256 checksum
How to use checksums
54fc5ec6b831fab79055c381e6154663fb7492027f33e9c8b3e2ffe6b4d4ab7a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

Release files / pipeline_analytics_sdk-3.0.15-py3-none-any.whl

Download URL pipeline_analytics_sdk-3.0.15-py3-none-any.whl
Size 153.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
80f1796f3111e1cabc4a1f291f63ad2a7f4ddfaca77c88ebd614ae0f25febe78
BLAKE2b-256 checksum
How to use checksums
674d2ca0ec5af540a88f6ab6f31ebbc30c76ae455b16807605eed29b65e4e45d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

Security for pipeline-analytics-sdk 3.0.15

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for pipeline_analytics_sdk-3.0.15.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

3.0.15 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page