Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

syschecks — Python SDK

PyPI version Python versions License: MIT

Official Python client for the Syschecks API — monitoring, incidents, on-call, status pages, playbooks and more. Fully typed, sync and async.

pip install syschecks

Usage

from syschecks import SyschecksClient
from syschecks.models import CheckCreate

sc = SyschecksClient(base_url="https://api.syschecks.com", token="sk_...")

checks = sc.checks.list_checks()
check = sc.checks.create_new_check(body=CheckCreate(name="api-prod", ...))
sc.incidents.list_incidents()
sc.oncall.get_schedule(schedule_id=3)
sc.playbooks.create_playbook(org_id=1, body=...)

Every endpoint is a method on its resource namespace (sc.<resource>.<operation>()), mirroring Stripe / Anthropic-style SDKs. Path parameters are positional, request bodies and query filters are keyword arguments — all fully typed with autocomplete.

Async

from syschecks import AsyncSyschecksClient

async with AsyncSyschecksClient(base_url="https://api.syschecks.com", token="sk_...") as sc:
    checks = await sc.checks.list_checks()

Errors

Unexpected HTTP statuses raise SyschecksError:

from syschecks import SyschecksError

try:
    sc.checks.get_check_details(check_id=999999)
except SyschecksError as exc:
    print(exc.status_code)

Pass raise_on_unexpected_status=False to opt out, or timeout= / httpx_args= to tune the underlying transport.

Architecture

This SDK is generated from the curated OpenAPI spec (the source of truth):

  • syschecks/_sdk/ — typed HTTP core + models, produced by openapi-python-client.
  • syschecks/resources/ — the fluent facade (Checks / AsyncChecks, …), generated by scripts/gen_facade.py, each method delegating to the core with client injected.
  • syschecks/client.pySyschecksClient / AsyncSyschecksClient, wiring the namespaces.
  • syschecks/models.py — the public request/response model surface.

Nothing under syschecks/ is hand-edited. Regenerate after a spec change:

./scripts/generate.sh            # uses ../syschecks-openapi/syschecks-openapi.json
./scripts/generate.sh path/to/spec.json

Streaming events

The /api/events SSE stream is exposed as an iterator — sync and async:

for event in sc.events.event_stream():
    print(event)

async for event in asc.events.event_stream():
    print(event)

Stability

0.x releases are alpha: the surface may change before 1.0.

Development

python -m pytest tests/       # structural smoke tests (no network)

Download files

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

Source Distribution

syschecks-0.1.0a8.tar.gz (216.3 kB view details)

Uploaded Source

Built Distribution

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

syschecks-0.1.0a8-py3-none-any.whl (728.5 kB view details)

Uploaded Python 3

File details

Details for the file syschecks-0.1.0a8.tar.gz.

File metadata

  • Download URL: syschecks-0.1.0a8.tar.gz
  • Upload date:
  • Size: 216.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for syschecks-0.1.0a8.tar.gz
Algorithm Hash digest
SHA256 f94356304a1190a1bb61a327829e4f86c1abd3772686a45a513860b042395259
MD5 74c64973bba0221dc3f4fbeddd3e4612
BLAKE2b-256 f3bcbeba821d42d70c26c638976b6ec943ad43356803d114d8c8375744b752ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for syschecks-0.1.0a8.tar.gz:

Publisher: release.yml on systeampl/syschecks-python

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

File details

Details for the file syschecks-0.1.0a8-py3-none-any.whl.

File metadata

  • Download URL: syschecks-0.1.0a8-py3-none-any.whl
  • Upload date:
  • Size: 728.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for syschecks-0.1.0a8-py3-none-any.whl
Algorithm Hash digest
SHA256 171f0d13cdea6cac969de64c281a5d9568dab83be2028150293dbeaa4b7704a4
MD5 d459904da40e7b55d0a4660b2527e655
BLAKE2b-256 1afac0b1b3c0a12acde759a72240314d973e1d7a2ee9abff36347675524358ca

See more details on using hashes here.

Provenance

The following attestation bundles were made for syschecks-0.1.0a8-py3-none-any.whl:

Publisher: release.yml on systeampl/syschecks-python

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 Sentry Error logging StatusPage Status page