hdx-python-country 4.1.2__tar.gz → 4.1.4__tar.gz

{hdx_python_country-4.1.2 → hdx_python_country-4.1.4}/.github/workflows/run-python-tests.yaml

@@ -25,7 +25,7 @@ jobs:
           python-version: "3.13"
 
       - name: Install dependencies
-        run: uv sync --frozen
+        run: uv sync --frozen --extra wfp
 
       - name: Check styling
         run: |
@@ -37,7 +37,7 @@ jobs:
 
       - name: Publish Unit Test Results
         uses: EnricoMi/publish-unit-test-result-action@v2
-        if: always()
+        if: success()
         with:
           files: test-results.xml
 

{hdx_python_country-4.1.2 → hdx_python_country-4.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hdx-python-country
-Version: 4.1.2
+Version: 4.1.4
 Summary: HDX Python country code and exchange rate (fx) utilities
 Project-URL: Homepage, https://github.com/OCHA-DAP/hdx-python-country
 Project-URL: Repository, https://github.com/OCHA-DAP/hdx-python-country
@@ -31,6 +31,8 @@ Requires-Dist: hdx-python-utilities<5,>=4.1.2
 Requires-Dist: tenacity
 Provides-Extra: docs
 Requires-Dist: mkapi; extra == 'docs'
+Provides-Extra: wfp
+Requires-Dist: data-bridges-client<10,>=9.0.0; extra == 'wfp'
 Description-Content-Type: text/markdown
 
 [![Build Status](https://github.com/OCHA-DAP/hdx-python-country/actions/workflows/run-python-tests.yaml/badge.svg)](https://github.com/OCHA-DAP/hdx-python-country/actions/workflows/run-python-tests.yaml)
@@ -140,3 +142,28 @@ To run the tests and view coverage, execute:
 The documentation, including API documentation, is generated using ReadtheDocs and
 MkDocs with Material. As you change the source code, remember to update the
 documentation at `documentation/index.md`.
+
+## WFP DataBridges Client
+
+The `WFPAPI` class (`hdx.location.wfp_api`) uses WFP's `data-bridges-client` library, which is
+published on WFP's own package index rather than PyPI. To install it, use the `wfp` extra with
+that index added:
+
+```shell
+    pip install "hdx-python-country[wfp]" \
+      --extra-index-url https://d2i4vvypvg40rv.cloudfront.net/pypi/ \
+      --index-strategy unsafe-best-match
+```
+
+If using `uv`, add the following to your project's `pyproject.toml`:
+
+```toml
+[tool.uv]
+index-strategy = "unsafe-best-match"
+
+[[tool.uv.index]]
+name = "wfp"
+url = "https://d2i4vvypvg40rv.cloudfront.net/pypi/"
+```
+
+then run `uv sync --extra wfp`.

{hdx_python_country-4.1.2 → hdx_python_country-4.1.4}/README.md

@@ -105,3 +105,28 @@ To run the tests and view coverage, execute:
 The documentation, including API documentation, is generated using ReadtheDocs and
 MkDocs with Material. As you change the source code, remember to update the
 documentation at `documentation/index.md`.
+
+## WFP DataBridges Client
+
+The `WFPAPI` class (`hdx.location.wfp_api`) uses WFP's `data-bridges-client` library, which is
+published on WFP's own package index rather than PyPI. To install it, use the `wfp` extra with
+that index added:
+
+```shell
+    pip install "hdx-python-country[wfp]" \
+      --extra-index-url https://d2i4vvypvg40rv.cloudfront.net/pypi/ \
+      --index-strategy unsafe-best-match
+```
+
+If using `uv`, add the following to your project's `pyproject.toml`:
+
+```toml
+[tool.uv]
+index-strategy = "unsafe-best-match"
+
+[[tool.uv.index]]
+name = "wfp"
+url = "https://d2i4vvypvg40rv.cloudfront.net/pypi/"
+```
+
+then run `uv sync --extra wfp`.

{hdx_python_country-4.1.2 → hdx_python_country-4.1.4}/pyproject.toml

@@ -42,6 +42,7 @@ dependencies = [
 
 [project.optional-dependencies]
 docs = ["mkapi"]
+wfp = ["data-bridges-client>=9.0.0,<10"]
 
 [dependency-groups]
 dev = [
@@ -49,6 +50,7 @@ dev = [
     "pytest-cov",
     "pre-commit",
     "ruff==0.14.13",
+    "data-bridges-client>=9.0.0,<10",
 ]
 
 [project.urls]
@@ -76,6 +78,17 @@ packages = ["src/hdx"]
 [tool.hatch.metadata]
 allow-direct-references = true
 
+# ----------------------------------------------------------------------------
+# uv (Package Management)
+# ----------------------------------------------------------------------------
+
+[tool.uv]
+index-strategy = "unsafe-best-match"
+
+[[tool.uv.index]]
+name = "wfp"
+url = "https://d2i4vvypvg40rv.cloudfront.net/pypi/"
+
 # ----------------------------------------------------------------------------
 # Ruff (Linting & Formatting)
 # ----------------------------------------------------------------------------