dhis2w-client

Pure async DHIS2 API client for Python. Pluggable auth (Basic / PAT / OAuth2-OIDC PKCE), pydantic-typed models from both /api/schemas and /api/openapi.json codegen, retry policy, period math, analytics helper. DHIS2 v41, v42, and v43, plus v44 as a preview against a pinned 2.44 development build.

Standalone — no profile system, no plugin runtime. Drop it in any async Python project that needs to talk to a DHIS2 instance.

Install

# Inside a uv-managed project
uv add dhis2w-client

Quickstart

from dhis2w_client import BasicAuth, Dhis2Client

async with Dhis2Client(
    base_url="https://play.im.dhis2.org/dev-2-43",
    auth=BasicAuth(username="admin", password="district"),
) as client:
    me = await client.system.me()
    print(me.username)

    elements = await client.resources.data_elements.list(fields="id,name", page_size=10)
    for de in elements:
        print(de.id, de.name)

PAT and OAuth2 (with token caching + refresh) work the same way:

from dhis2w_client import Dhis2Client, OAuth2Auth

auth = OAuth2Auth(
    base_url="https://dhis2.example.org",
    client_id="my-app",
    client_secret="...",
    scope="ALL",
    redirect_uri="http://localhost:8765",
    token_store=my_token_store,
    store_key="profile:prod",
)
async with Dhis2Client("https://dhis2.example.org", auth=auth) as client:
    ...

What's in the box

Async HTTP via httpx with a pluggable retry transport (429 / 502 / 503 / 504 with Retry-After honoring).
Typed metadata accessors for every resource DHIS2 exposes via /api/schemas — generated per DHIS2 version under dhis2w_client.generated.v{41,42,43,44}.
Tracker read + write helpers (client.tracker.register / enroll / event_create / outstanding).
Analytics — client.analytics.aggregate(dx=..., pe=..., ou=...) -> Grid for parsed responses, stream_to(...) for very large pivots.
Period math — parse_period, next_period_id, previous_period_id, period_start_end across all six absolute period shapes.
Pluggable auth — BasicAuth, PatAuth, OAuth2Auth. Add your own by implementing the AuthProvider Protocol.
Bulk operations — patch_bulk, apply_sharing_bulk, fanned out over a pool of concurrency workers that pull records one at a time, so memory stays flat however long the input list is.

Documentation

Full docs at https://winterop-com.github.io/dhis2w/.

The dhis2w-client package is one member of the dhis2w workspace. The CLI (dhis2w-cli) builds on this client, and so do the plugin packs in their own repositories: the MCP server (dhis2w-mcp) and the Playwright helpers (dhis2w-browser).

Metadata

Release files for dhis2w-client 1.31.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dhis2w-client 1.31.0
File	Size	Uploaded
dhis2w_client-1.31.0.tar.gz	2.9 MB	Oct 1, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for dhis2w-client 1.31.0
File	Interpreter	ABI	Platform	Reset
dhis2w_client-1.31.0-py3-none-any.whl 4.7 MB Oct 1, 2026	Python 3	none	any	Details

Total release size: 7.5 MB

Release files / dhis2w_client-1.31.0.tar.gz

Download URL	dhis2w_client-1.31.0.tar.gz
Size	2.9 MB
Tags	Source
SHA-256 checksum How to use checksums	`88e9e6805f904af44f12a47c0a89ad9eed5790020a5df9ff06acd481d791f2b4`
BLAKE2b-256 checksum How to use checksums	`4ea20e2ed61b5e81b5f2926551648312c84da19c8870a8ee4fc42a42bd0ab4e9`
Upload date	Oct 1, 2026
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.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/winterop-com/dhis2w
Publishing commit: github.com/winterop-com/dhis2w/tree/6bb8e1f97e1e7220eccf40c23f2cf64aac299f9d

Workflow

Publishing configuration: github.com/winterop-com/dhis2w/blob/6bb8e1f97e1e7220eccf40c23f2cf64aac299f9d/.github/workflows/pypi-publish.yml
Publishing logs: github.com/winterop-com/dhis2w/actions/runs/36844750475/attempts/1

Artifact

Subject: dhis2w_client-1.31.0.tar.gz
SHA-256 checksum: 88e9e6805f904af44f12a47c0a89ad9eed5790020a5df9ff06acd481d791f2b4 Verifying attestations

Release files / dhis2w_client-1.31.0-py3-none-any.whl

Download URL	dhis2w_client-1.31.0-py3-none-any.whl
Size	4.7 MB
Tags	Python 3
SHA-256 checksum How to use checksums	`0e315b6ae5a611798675cbc184a2569fb524fe00bc5f1a2f2af2de60ddbabd4b`
BLAKE2b-256 checksum How to use checksums	`026714619b2c320f92198699b52b3d87a54d6c0f686a668cd2c32066f228c478`
Upload date	Oct 1, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/winterop-com/dhis2w
Publishing commit: github.com/winterop-com/dhis2w/tree/6bb8e1f97e1e7220eccf40c23f2cf64aac299f9d

Workflow

Publishing configuration: github.com/winterop-com/dhis2w/blob/6bb8e1f97e1e7220eccf40c23f2cf64aac299f9d/.github/workflows/pypi-publish.yml
Publishing logs: github.com/winterop-com/dhis2w/actions/runs/36844750475/attempts/1

Artifact

Subject: dhis2w_client-1.31.0-py3-none-any.whl
SHA-256 checksum: 0e315b6ae5a611798675cbc184a2569fb524fe00bc5f1a2f2af2de60ddbabd4b Verifying attestations