dirigent-dhis2
Documentation: https://winterop-com.github.io/dirigent-dhis2/
The DHIS2 adapter pack for dirigent. It
contributes the dhis2 connection kind, three JSON Schema formats (dhis2-uid,
dhis2-period and dhis2-code), and the blocks that speak DHIS2's asynchronous jobs, import summaries,
completeness registrations, metadata, tracker and analytics reads as first-class steps,
rather than composing them out of raw HTTP:
| Block | Kind | What it does |
|---|---|---|
dhis2.analytics_run |
operator | Submits the analytics tables job and follows its task notifications to the end. |
dhis2.analytics_query |
operator | Runs one analytics query, aggregate or event/enrollment, and hands the grid on. |
dhis2.data_value_set_export |
operator | Reads a data value set for a data set, period and org unit, and hands the document on. |
dhis2.data_value_set_import |
operator | Imports a data value set, parsing the import summary and its conflicts. |
dhis2.metadata |
operator | Reads one metadata collection through the version-bound generic accessor. |
dhis2.tracker |
operator | Reads a page of tracked entities, enrollments or events from /api/tracker. |
dhis2.data_set_complete |
sensor | Holds a run until a data set is marked complete for the period. |
Every block classifies its failures the dhis2w-client way: an instance whose version the client does not speak is refused rather than retried, and a transport failure is transient.
An instance discovers the pack by installing it: the dirigent.plugins.v1 entry point in
pyproject.toml is the whole registration.
Install
Install the pack into the dirigent image:
uv pip install dirigent-dhis2
or add it to a project:
uv add dirigent-dhis2
Develop
uv sync --locked
uv run ruff format --check . && uv run ruff check .
uv run mypy && uv run pyright
uv run pytest
NO_MKDOCS_2_WARNING=1 uv run mkdocs build --strict
The tutorial is published as a page and as paper. The PDF is printed from the built site with
headless Chromium, lands in site/, and is never committed:
uv run --with playwright playwright install chromium
uv run --with playwright python scripts/docs_pdf.py
That is what CI runs. The variable silences Material's notice about MkDocs 2.0. The lock file is committed and CI syncs against it, so a pack build is reproducible; the ecosystem's nightly integration is what proves the pack against a live instance.
tests/ exercises every block against a mocked DHIS2 instance, and tests/test_examples.py
validates the example documents against the pack's own catalog. The examples run standalone,
each carrying the connection it uses.
Examples
The shelves are installed with the pack: dirigent_dhis2 contributes them through the
examples() hook, so an instance with the pack installed lists them with
dg examples list --plugin dhis2
dg examples list --plugin dhis2 --starter
They live in src/dirigent_dhis2/shelves/, and the root
examples/ is a symlink to it so dg run --local examples/... reads from a checkout.
One file per operation, grouped by how it is built:
| Shelf | What is in it |
|---|---|
dhis2/ |
The native adapter: exports and their import strategies, the sign-off gate, the analytics reads and rebuilds, the three tracker collections, the metadata reads. |
dhis2-compose/ |
A dhis2.* block beside one of the engine's own: a schema gate, a jq reshape, a fan-out over org units, a write to storage and the read back. |
dhis2-http/ |
The generic-HTTP way, for what no adapter covers: a CSV export, a period range, a completion registration, a stage-scoped event read. |
validate/ |
A metadata read held to a shape: a fields= projection gated on validate.schema, with the schema carried and named. |
schemas/ |
The JSON Schemas that pin the reads the DHIS2 series makes, applied on their own. |
starters/ |
The documents tagged starter: the same flows naming a dhis2 connection rather than carrying one, which is what dg pipeline new copies into a project. |
Each shelf's README lists its files one line each. Every shelf but starters/ carries the
connection it uses so each document runs standalone; a server refuses a carried connection,
so the starters are the ones an instance accepts unedited.
Licence
Copyright (c) 2026 Morten Olav Hansen. All rights reserved. See LICENSE.
The source is published for reference only: no licence to use, copy, modify or distribute it is granted, and any use beyond reading requires written permission.
1 maintainer
Release files for dirigent-dhis2 0.16.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| dirigent_dhis2-0.16.2.tar.gz | 71.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| dirigent_dhis2-0.16.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 201.1 kB
Release files / dirigent_dhis2-0.16.2.tar.gz
| Download URL | dirigent_dhis2-0.16.2.tar.gz |
|---|---|
| Size | 71.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f551c0b966e8acbdcb210f1342402618b4e9de3e26ec7b00a5c2d6b4a000dc2c
|
|
BLAKE2b-256 checksum How to use checksums |
47d7725a64f81994846b20552bc71ddf836cdb79f1ae8b8ca63f24ba832fe68b
|
| 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 Sep 17, 2026.
Transparency logRelease files / dirigent_dhis2-0.16.2-py3-none-any.whl
| Download URL | dirigent_dhis2-0.16.2-py3-none-any.whl |
|---|---|
| Size | 129.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
41c7960895774a8c7dce312f9add181b9334d5f354be01f2be98cd8d7b7c97fe
|
|
BLAKE2b-256 checksum How to use checksums |
6f8d6056ae849f4acedb889d4a70e12a093c104e731dc678820372fa41df7a3d
|
| 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 Sep 17, 2026.
Transparency log
