Skip to main content

PyPI version Python versions CI License: MPL 2.0 Checked with mypy Ruff

oack

Official Python client for the Oack monitoring API.

Installation

Note: PyPI publishing is temporarily unavailable. Install directly from GitHub:

pip install git+https://github.com/oack-io/oack-python.git

# or pin to a specific version
pip install git+https://github.com/oack-io/oack-python.git@v0.1.0

In requirements.txt:

oack @ git+https://github.com/oack-io/oack-python.git@v0.1.0

In pyproject.toml (PEP 621):

dependencies = [
    "oack @ git+https://github.com/oack-io/oack-python.git@v0.1.0",
]

Once published to PyPI, the standard install will work:

pip install oack

Quick Start

from oack import AsyncOack

async with AsyncOack(api_key="sk-...") as client:
    teams = await client.teams.list()
    for team in teams:
        print(team.id, team.name)

Sync

from oack import Oack

with Oack(api_key="sk-...") as client:
    teams = client.teams.list()
    for team in teams:
        print(team.id, team.name)

Configuration

client = AsyncOack(
    api_key="sk-...",
    base_url="https://api.oack.io",  # default
    timeout=30.0,                     # seconds, default
    max_retries=2,                    # default
)

# Dynamic token (e.g. refreshable JWT)
client = AsyncOack(api_key_func=lambda: get_current_jwt())

Browser Login (Device Flow)

Authenticate via browser instead of a static API key. The JWT lives only in memory and disappears when the program exits.

from oack import Oack, device_flow_authenticate

# Opens your browser, waits for approval, returns JWT
token = device_flow_authenticate()

with Oack(api_key=token) as client:
    teams = client.teams.list()

Async version:

from oack import AsyncOack, async_device_flow_authenticate

token = await async_device_flow_authenticate()

async with AsyncOack(api_key=token) as client:
    teams = await client.teams.list()

Error Handling

from oack import AsyncOack, NotFoundError, RateLimitError, APIError

try:
    monitor = await client.monitors.get(team_id, monitor_id)
except NotFoundError:
    print("Monitor not found")
except RateLimitError as e:
    print(f"Rate limited, retry after {e.retry_after}s")
except APIError as e:
    print(f"API error {e.status_code}: {e.message}")

Resources

Resource Access Key Methods
Accounts client.accounts create, list, get, update, delete, restore, transfer
Teams client.teams create, list, get, update, delete, list_members, add_member
Monitors client.monitors create, list, get, update, delete, pause, unpause, duplicate, move
Probes client.probes list, get, get_details, download_pcap, aggregate
Alert Channels client.alert_channels create, list, get, update, delete, test
Metrics client.metrics get_monitor_metrics, get_expiration, list_timeline, chart events
Geo client.geo list_checkers, list_regions

Types

All response types are Pydantic v2 models with full IDE autocomplete:

from oack.types import Monitor, Team, Probe, CreateMonitorParams

Metadata

Release files for oack 0.2.1

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

Source distribution (sdist)

Source distribution for oack 0.2.1
File Size Uploaded Provenance Actions
oack-0.2.1.tar.gz 72.5 kB With provenance Details for oack-0.2.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for oack 0.2.1
File Interpreter ABI Platform Actions
oack-0.2.1-py3-none-any.whl Python 3 none any Details for oack-0.2.1-py3-none-any.whl

Total release size: 124.6 kB

Release files / oack-0.2.1.tar.gz

Download URL oack-0.2.1.tar.gz
Size 72.5 kB
Tags Source
SHA-256 checksum
How to use checksums
27ad9dfa6f28c4229f06572340ecdaa739dba816fba27c8eb2b079039e0d3eca
BLAKE2b-256 checksum
How to use checksums
bfe764d6f56090ad023fe8619b408fc7ea15d0f3fbaccdf630494e06e2fc45c9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

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 Apr 10, 2026.

Transparency log

Release files / oack-0.2.1-py3-none-any.whl

Download URL oack-0.2.1-py3-none-any.whl
Size 52.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
18da950a7329549460db3cfd1ae933ff7f343994035fcf4aa1af1f6a4dcc4d96
BLAKE2b-256 checksum
How to use checksums
069c28f78336a3f11da82089f631cdec7ff830ba8ff296f9d1a36de996c9a71f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

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 Apr 10, 2026.

Transparency log

Security for oack 0.2.1

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 oack-0.2.1.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 Apr 10, 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

0.2.1 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