The HDX Python Country Library provides utilities to map between country and region codes and names and to match administrative level names from different sources. It also provides utilities for foreign exchange enabling obtaining current and historic FX rates for different currencies.
It provides country mappings including ISO 2 and ISO 3 letter codes (ISO 3166) and regions using live official data from the UN OCHA feed with fallbacks to an internal static file if there is any problem with retrieving data from the url. (Also it is possible to force the use of the internal static files.)
It can exact match English, French, Spanish, Russian, Chinese and Arabic. There is a fuzzy matching for English look up that can handle abbreviations in country names like Dem. for Democratic and Rep. for Republic.
Mapping administration level names from a source to a given base set is also handled including phonetic fuzzy name matching.
It also provides foreign exchange rates and conversion from amounts in local currency to USD and vice-versa. The conversion relies on Yahoo Finance, falling back on currency-api for current rates, and Yahoo Finance falling back on IMF data via IATI (with interpolation) for historic daily rates.
For more information, please read the documentation.
This library is part of the Humanitarian Data Exchange (HDX) project. If you have humanitarian related data, please upload your datasets to HDX.
Development
Environment
Development is currently done using Python 3.13. The environment can be created with:
uv sync
This creates a .venv folder with the versions specified in the project's uv.lock file.
Pre-commit
pre-commit will be installed when syncing uv. It is run every time you make a git commit if you call it like this:
pre-commit install
With pre-commit, all code is formatted according to ruff guidelines.
To check if your changes pass pre-commit without committing, run:
pre-commit run --all-files
Packages
uv is used for package management. If
you’ve introduced a new package to the source code (i.e. anywhere in src/),
please add it to the project.dependencies section of pyproject.toml with
any known version constraints.
To add packages required only for testing, add them to the
[dependency-groups].
Any changes to the dependencies will be automatically reflected in
uv.lock with pre-commit, but you can re-generate the files without committing by
executing:
uv lock --upgrade
Project
uv is used for project management. The project can be built using:
uv build
Linting and syntax checking can be run with:
uv run ruff check
To run the tests and view coverage, execute:
uv run pytest
Documentation
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:
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:
[tool.uv]
index-strategy = "unsafe-best-match"
[[tool.uv.index]]
name = "wfp"
url = "https://d2i4vvypvg40rv.cloudfront.net/pypi/"
then run uv sync --extra wfp.
1 maintainer
Metadata
1 maintainer
Release files for hdx-python-country 4.2.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 | |
|---|---|---|---|
| hdx_python_country-4.2.2.tar.gz | 561.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hdx_python_country-4.2.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 618.7 kB
Release files / hdx_python_country-4.2.2.tar.gz
| Download URL | hdx_python_country-4.2.2.tar.gz |
|---|---|
| Size | 561.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fff26ccc860fa7d4dd90dab7e37abd5a1fdb85a697903db4fd75a0fddae7cdc2
|
|
BLAKE2b-256 checksum How to use checksums |
9261ce016981306bdff1bc60c47b44023f03ab2db6d69ee265e7df74cdc9f20b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.21 {"installer":{"name":"uv","version":"0.12.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / hdx_python_country-4.2.2-py3-none-any.whl
| Download URL | hdx_python_country-4.2.2-py3-none-any.whl |
|---|---|
| Size | 57.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
70b00b86556d887faa501349945e569f785f22fc2dae95d6225663c310e8b641
|
|
BLAKE2b-256 checksum How to use checksums |
457265efa1b449cc110aa4f8dad4fbf0251c9394400339bd0a6fe2a6570ecef6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.21 {"installer":{"name":"uv","version":"0.12.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
