Python client for Ablago
Deutsch · English
The package ablago talks to Ablago, the self-hosted document filing for home and small businesses, from Python. It is the basis of the Home Assistant integration and works for your own scripts, monitoring and tools.
pip install ablago # convenience layer: counters and health
pip install "ablago[api]" # plus the complete API (ablago.api)
Python 3.12 or newer.
Quick start
import asyncio
from ablago import AblagoClient, AblagoAuthError, AblagoConnectionError
async def main():
async with AblagoClient("https://ablago.example.org", api_key="dms_…") as client:
counters = await client.zaehler()
print(counters.neue_post, counters.zu_erledigen, counters.ueberfaellig)
asyncio.run(main())
Create the key in Ablago under My account → Security → API keys. For the counters, the level “counters only” is enough – do not use a higher one than needed.
Names follow the Ablago API, which is German: zaehler = counters, neue_post = new mail, zu_erledigen = to do, ueberfaellig = overdue, gesundheit = health.
Two layers
| Part | What | Dependencies |
|---|---|---|
ablago |
Convenience layer, hand-written: AblagoClient with zaehler() and gesundheit(), clear errors |
aiohttp |
ablago.api |
Complete API, generated from Ablago’s API description: one function per route (sync and async), one typed class per object | httpx2, attrs (extra [api]) |
AblagoClient(address, api_key=None, *, session=None, verify_ssl=True, timeout=10). A session you pass in (e.g. Home Assistant’s) stays open afterclose().await client.zaehler()→Zaehlerstand(neue_post, zu_erledigen, ueberfaellig, stand, geaendert), with ETag/304: unchanged counters cost almost nothing.await client.gesundheit()→Gesundheit(ok, zustand, seit), no key needed, never reveals the version.- Redirects are not followed, so the key never goes to another address.
Errors all derive from AblagoError: AblagoAuthError (key wrong, expired, revoked or without permission – replace the key), AblagoConnectionError (unreachable, timeout, 5xx – retry later), AblagoSSLError (certificate does not match; subclass of AblagoConnectionError).
from ablago.api import AuthenticatedClient
from ablago.api.api.ablage import get_mappen
async with AuthenticatedClient(base_url="https://ablago.example.org/api/v1", token="dms_…") as client:
folders = await get_mappen.asyncio(client=client)
All routes are described in the API documentation.
Keeping up with Ablago
ablago.api is generated from openapi/openapi.json, the API description of a fixed Ablago version (openapi/ABLAGO_VERSION). Once a day a workflow checks for a new Ablago release and opens a pull request if the API changed: additions only → minor version; removals or changes → marked and decided by hand.
Privacy
The client only talks to the address you give it and sends nothing to third parties. It stores nothing on disk.
License
Apache-2.0
Metadata
Release files for ablago 0.1.0
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 |
|---|---|---|---|---|
| ablago-0.1.0.tar.gz | 306.0 kB | With provenance | Details for ablago-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ablago-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for ablago-0.1.0-py3-none-any.whl |
Total release size: 1.0 MB
Release files / ablago-0.1.0.tar.gz
| Download URL | ablago-0.1.0.tar.gz |
|---|---|
| Size | 306.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1571862fdb3902b3c461514e9c32975829786c03eb4d403d43e828f08203ca62
|
|
BLAKE2b-256 checksum How to use checksums |
51da55e08a4d8908a21ae7cb24a5eb47f25367161775346db1028fcfa5d08b98
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 Nov 16, 2026.
Transparency logRelease files / ablago-0.1.0-py3-none-any.whl
| Download URL | ablago-0.1.0-py3-none-any.whl |
|---|---|
| Size | 698.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9d87cb29eebd0b80e8d031fd51c46fdfce765f0c9bb325d43c0fbe2ba942758f
|
|
BLAKE2b-256 checksum How to use checksums |
b434f27791ae39ddd0705552f9f7f19deabdc223bf6eb8462dac2c5c585863a0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 Nov 16, 2026.
Transparency logSecurity for ablago 0.1.0
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 ablago-0.1.0.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 Nov 16, 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.