This release is a pre-release and may not be stable for production use.
oblidog-client
Python client for the Oblidog integration API.
Use the handwritten OblidogClient facade in application code. The
oblidog_client.generated namespace is OpenAPI-generated transport code and is
an implementation detail, not the recommended SDK API.
Installation
pip install oblidog-client
Usage
import datetime
from oblidog_client import OblidogClient
with OblidogClient(base_url="https://oblidog.example.com", api_key="fdg_live_...") as client:
with client.integrations.run() as run:
client.category_data.create(
observed_at=datetime.datetime.now(datetime.UTC),
data={"meter_reading_kwh": 1234.5},
)
run.finish_success(changes_detected=True)
The integration API key selects its integration and category. Use
client.integrations.run() around synchronization work: it reads context and
starts a run before the block, then reports a sanitized failure if the block
raises.
Documentation
The full documentation is published at oblidog.github.io/oblidog-client-python. It includes a quickstart, public API reference, and supported API boundary; it intentionally excludes generated endpoints and transport classes.
Development
This project uses uv for dependency and environment management. The low-level client is generated from the Oblidog Ledger integration OpenAPI contract; generated code should not be edited manually.
Use Commitizen to create Conventional Commit messages interactively, or to validate one non-interactively:
uv run cz commit
uv run cz check -m "feat: add a new capability"
Run the same distribution verification used by CI locally:
./scripts/verify-package.sh
The command builds the wheel and source distribution, validates their metadata and contents, installs the wheel into a clean environment, and checks the installed public API. It does not publish any artifacts.
Release maintainers should follow the Trusted Publishing setup and release procedure.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file oblidog_client-0.1.1rc1.tar.gz.
File metadata
- Download URL: oblidog_client-0.1.1rc1.tar.gz
- Upload date:
- Size: 111.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f3f27000bea07a61f77c60f765011ec79fa561cbf53e80f91c001efcbabc9d61
|
|
| MD5 |
5871ba20e842239c392860ff68c103a5
|
|
| BLAKE2b-256 |
eb2168841f20a06805c6b378bbcc5594735ce81aa864606bcf386aafa15faf87
|
Provenance
The following attestation bundles were made for oblidog_client-0.1.1rc1.tar.gz:
Publisher:
release.yml on oblidog/oblidog-client-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
oblidog_client-0.1.1rc1.tar.gz -
Subject digest:
f3f27000bea07a61f77c60f765011ec79fa561cbf53e80f91c001efcbabc9d61 - Sigstore transparency entry: 2797588169
- Sigstore integration time:
-
Permalink:
oblidog/oblidog-client-python@e79f37ef1bfc442864a67d7ec54a9bf4451d358e -
Branch / Tag:
refs/tags/v0.1.1rc1 - Owner: https://github.com/oblidog
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@e79f37ef1bfc442864a67d7ec54a9bf4451d358e -
Trigger Event:
release
-
Statement type:
File details
Details for the file oblidog_client-0.1.1rc1-py3-none-any.whl.
File metadata
- Download URL: oblidog_client-0.1.1rc1-py3-none-any.whl
- Upload date:
- Size: 68.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
39787b85eeea696a5da77c26755cd625522410ead12392e7308f74d2c37df1f1
|
|
| MD5 |
02faecaebd40149d51a50f89bdca0d3d
|
|
| BLAKE2b-256 |
0c1514d9bc677ea69744504683edb6babe7bf0b6dc81dae111c2c79893aa654e
|
Provenance
The following attestation bundles were made for oblidog_client-0.1.1rc1-py3-none-any.whl:
Publisher:
release.yml on oblidog/oblidog-client-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
oblidog_client-0.1.1rc1-py3-none-any.whl -
Subject digest:
39787b85eeea696a5da77c26755cd625522410ead12392e7308f74d2c37df1f1 - Sigstore transparency entry: 2797588290
- Sigstore integration time:
-
Permalink:
oblidog/oblidog-client-python@e79f37ef1bfc442864a67d7ec54a9bf4451d358e -
Branch / Tag:
refs/tags/v0.1.1rc1 - Owner: https://github.com/oblidog
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@e79f37ef1bfc442864a67d7ec54a9bf4451d358e -
Trigger Event:
release
-
Statement type:
