Merge pull request #7 from dhis2/chore/publishable-packaging

build: make the package publishable to PyPI (0.3.2)

Author: abyot

.github/workflows/publish.yml

@@ -0,0 +1,42 @@
+name: Publish to PyPI
+
+# Builds and uploads a release when a version tag is pushed. Uses PyPI trusted
+# publishing, so no token is stored: the project on PyPI must list this repository,
+# this workflow file and the "pypi" environment as a trusted publisher.
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Check the tag matches the package version
+        run: |
+          version=$(python -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
+          test "v${version}" = "${GITHUB_REF_NAME}" || { echo "tag ${GITHUB_REF_NAME} does not match version ${version}"; exit 1; }
+      - name: Build
+        run: python -m pip install --upgrade build && python -m build
+      - name: Check metadata
+        run: python -m pip install --upgrade twine && twine check dist/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: python -m pip install --upgrade pip && pip install -e .[dev]
+      - name: Lint
+        run: ruff check .
+      - name: Unit tests
+        run: pytest -q

.gitignore

@@ -13,3 +13,6 @@ build/
 .coverage
 htmlcov/
 .codex
+*.egg-info/
+.pytest_cache/
+.ruff_cache/

CHANGELOG.md

@@ -1,19 +1,19 @@
 # Changelog
 
+## [0.3.2] - 2026-10-05
+### Added
+- `LICENSE` file (BSD-3-Clause), `py.typed` marker, and PyPI metadata (classifiers, URLs, keywords).
+- GitHub Actions: tests and lint on every push and pull request; publish to PyPI on a `v*` tag through trusted publishing.
+### Changed
+- The `dev` extra now installs everything the test suite needs (`respx`, `python-dotenv`); `matplotlib` moved to an `examples` extra.
+- Lint clean under the repository's ruff configuration.
+- First release on PyPI: `pip install dhis2-client`.
+
 ## [0.3.1] - 2026-04-14
 ### Changed
 - Corrected release wording from "Centrlized" to "Centralized".
 - Added separate `connect_timeout` control (default `60s`) while keeping `timeout` for read/write/pool (default `30s`).
 
-## [0.1.0] - 2025-09-21
-### Added
-- Sync `DHIS2Client` using httpx (dict/JSON only).
-- Stdlib JSON logging via `ClientSettings`.
-- Clean paging (`list_paged`, `fetch_all`).
-- Resources: Users (read-only), OrgUnits (CRUD + geojson), DataElements (CRUD),
-  DataSets (CRUD), DataValues (single + sets), Analytics (read), System info.
-- Unit tests (respx) + live integration tests (guarded by env).
-
 ## [0.3.0] - 2025-10-08
 ### Added
 - Analytics: latest_period_for_level(de_uid, level) using /api/dataValueSets with calendar-aware windows.
@@ -23,3 +23,17 @@
 - HTTP timeout controls: added `connect_timeout` (default 60s) while keeping `timeout` for read/write/pool (default 30s).
 ### Validation
 - Error if data element is linked to datasets with mixed periodType.
+
+## [0.2.0] - 2025-10-01
+### Added
+- Sharing: read and set public access, user and user-group accesses on metadata objects.
+- User organisation-unit scope management (capture, data view, tracked-entity search).
+
+## [0.1.0] - 2025-09-21
+### Added
+- Sync `DHIS2Client` using httpx (dict/JSON only).
+- Stdlib JSON logging via `ClientSettings`.
+- Clean paging (`list_paged`, `fetch_all`).
+- Resources: Users (read-only), OrgUnits (CRUD + geojson), DataElements (CRUD),
+  DataSets (CRUD), DataValues (single + sets), Analytics (read), System info.
+- Unit tests (respx) + live integration tests (guarded by env).

LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2025-2026, HISP Centre, University of Oslo
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -66,16 +66,16 @@ This client provides a **lightweight and simple** way to work with the DHIS2 Web
 
 > Requires **Python 3.10+**
 
-At this stage the package is not yet published on PyPI.  
-You can install it from source:
+```bash
+pip install dhis2-client
+```
+
+To work on the client itself, install it from a checkout with the development extras:
 
 ```bash
-# Clone the repo
 git clone https://github.com/dhis2/dhis2-python-client.git
 cd dhis2-python-client
-
-# Install in editable/development mode
-pip install -e .
+pip install -e .[dev]
 ```
 
 ---

conftest.py

@@ -3,7 +3,6 @@
 import sys
 from pathlib import Path
 
-
 SRC_DIR = Path(__file__).resolve().parent / "src"
 if str(SRC_DIR) not in sys.path:
     sys.path.insert(0, str(SRC_DIR))

examples/example_1_org_unit_fetch.py

@@ -1,6 +1,7 @@
 from itertools import islice
 
 from examples._config import make_client
+
 client = make_client()
 
 ous = list(client.get_organisation_units())
@@ -22,4 +23,4 @@
 #client = DHIS2Client(base_url="http://localhost:9090", token="d2p_RSY3qHZ6bCkRghud0afwMIlaTlXI2PefJLhwc2ZEaoZo1bhsFZ")
 
 #ous = list(client.get_organisation_units())
-#print("▶ Total number of ous available: ", len(ous))
+#print("▶ Total number of ous available: ", len(ous))

examples/example_2_geojson_fetch.py

@@ -1,9 +1,11 @@
-import matplotlib.pyplot as plt
-import geopandas as gpd
 import io
 import json
 
+import geopandas as gpd
+import matplotlib.pyplot as plt
+
 from examples._config import make_client
+
 client = make_client()
 
 info = client.get_system_info()
@@ -26,4 +28,4 @@
 
 plt.axis('equal')
 plt.tight_layout()
-plt.show()
+plt.show()

examples/example_3_data_element_fetch.py

@@ -1,4 +1,5 @@
 from examples._config import make_client
+
 client = make_client()
 
 fields='id,displayName,valueType,domainType'