InOrbit SDK for Python
The runtime for the InOrbit API, and its public surface, in a blocking and an asyncio
form. On PyPI since 0.1.0, for Python 3.11 or later:
pip install inorbithr # or: uv add inorbithr
from inorbithr import Public
api = Public.from_env() # INORBIT_TOKEN, or INORBIT_KEY_ID + INORBIT_KEY_SECRET + INORBIT_SCOPES
me = api.me().value
digests = api.radar.list_digests(limit=3).value
AsyncPublic is the same on asyncio (await api.me()). examples/python
holds both as programs CI type-checks.
A surface cut to what your own credentials may call comes from the command line:
iohr sdk generate --lang python --for default --out src/iohr
It writes one class per profile, blocking and asyncio, each holding only the operations
its cut holds; pyright and mypy refuse a call a profile may not make.
-
Errors are one tree under
InOrbitError;ApiErrorcarries the API'scode,statusand typeddetails. -
Idempotent calls (
GET,PUT,DELETE) are retried on 429, 503, 504 and connection failures, at most twice, honouringRetry-After; writes are not. -
64-bit integers are
int, sent as decimal strings; a message field the API left out isNone; fields this version does not know are kept. -
Every request field is optional (
Noneby default) and left out when unset; an answer's field is optional unless the API always sends it. Timestamps stay the strings the API sent;parse_timestampreads one,""(unset) asNone. -
A paged list has an
all_<operation>beside its page method that follows the next-page token:for d in api.radar.all_list_digests(): ..., orasync foron theasyncioclass; stopping the loop fetches nothing more. -
A streaming operation hands back a
Streamthat opens on the first step of the loop and yields one model per event;AsyncStreamon theasyncioclass. Leaving thewith(orclose()) stops it:with api.events.stream_events(types="key.created") as events: for event in events: print(event.type, event.id)
Streams open over server-sent events, or with
Client(streams="socket")every stream of the client shares one/v1/wsconnection, opened again when the server ends it. A stream silent forstream_idle_timeout(45 s) ends withApiTimeoutError; anerrorevent or frame is anApiError; a revoked key ends the stream withunauthenticated. -
Python 3.11 or newer; the dependencies are
httpx,pydantic2 andwebsockets(for the socket).
How the SDKs behave in every language: docs/design.md.
Metadata
Release files for inorbithr 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| inorbithr-0.2.1.tar.gz | 47.4 kB | With provenance | Details for inorbithr-0.2.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| inorbithr-0.2.1-py3-none-any.whl | Python 3 | none | any | Details for inorbithr-0.2.1-py3-none-any.whl |
Total release size: 100.7 kB
Release files / inorbithr-0.2.1.tar.gz
| Download URL | inorbithr-0.2.1.tar.gz |
|---|---|
| Size | 47.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9fea4f06b601667d09d8223869464caa5547bf1d6c093438a14471cd48e68b2d
|
|
BLAKE2b-256 checksum How to use checksums |
391a36d0239a0a953afcbc59481fe5434c3f29ac1739b553b03d7c087a66e9b5
|
| 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 4, 2026.
Transparency logRelease files / inorbithr-0.2.1-py3-none-any.whl
| Download URL | inorbithr-0.2.1-py3-none-any.whl |
|---|---|
| Size | 53.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b301f7531cec5f08961f38e6f406c4004a8f6a994d3c4bc998e3462ca3f8355e
|
|
BLAKE2b-256 checksum How to use checksums |
aed99a642040124bbb3277af2a8e6a3cd9f9d65dba16d3a38e7c898406e726f1
|
| 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 4, 2026.
Transparency logSecurity for inorbithr 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.
Attestation for inorbithr-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 Oct 4, 2026.
Transparency logA 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.