Skip to main content

HDX Python country code and exchange rate (fx) utilities

Project description

Build Status Coverage Status Ruff Downloads

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.12. We recommend using a virtual environment such as venv:

    python -m venv venv
    source venv/bin/activate

In your virtual environment, install all packages for development by running:

    pip install -r requirements.txt

Pre-commit

Be sure to install pre-commit, which is run every time you make a git commit:

    pip install pre-commit
    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

Testing

Ensure you have the required packages to run the tests:

    pip install -r requirements.txt

To run the tests and view coverage, execute:

    pytest -c --cov hdx

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 test section under [project.optional-dependencies].

Any changes to the dependencies will be automatically reflected in requirements.txt with pre-commit, but you can re-generate the file without committing by executing:

    pre-commit run pip-compile --all-files

Project

Hatch is used for project management. The project can be built using:

    hatch build

Linting and syntax checking can be run with:

    hatch fmt --check

Tests can be executed using:

    hatch test

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hdx_python_country-3.9.5.tar.gz (529.2 kB view details)

Uploaded Source

Built Distribution

hdx_python_country-3.9.5-py3-none-any.whl (55.5 kB view details)

Uploaded Python 3

File details

Details for the file hdx_python_country-3.9.5.tar.gz.

File metadata

  • Download URL: hdx_python_country-3.9.5.tar.gz
  • Upload date:
  • Size: 529.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for hdx_python_country-3.9.5.tar.gz
Algorithm Hash digest
SHA256 1db9872a083c8bd0632ae13247b48011ab4655265b7967f73eeac88123168879
MD5 b1deb9901e00bc5913cd3ae6dfa5e06d
BLAKE2b-256 1d6b424edb0f0834cd645a9ea97e2741046d42dbc54407eaef17bcd160f8e58d

See more details on using hashes here.

Provenance

The following attestation bundles were made for hdx_python_country-3.9.5.tar.gz:

Publisher: publish.yaml on OCHA-DAP/hdx-python-country

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file hdx_python_country-3.9.5-py3-none-any.whl.

File metadata

File hashes

Hashes for hdx_python_country-3.9.5-py3-none-any.whl
Algorithm Hash digest
SHA256 6e21b3f904564c8ef61835f063d2bcefff11393967bbe261b42ea87fe82f9b7c
MD5 61aefbe2f291452aa92062d85bc20069
BLAKE2b-256 459a19b60f18d26bc674cc5c5e6a55ea0ec1da3713df6a307dfe6881486464f3

See more details on using hashes here.

Provenance

The following attestation bundles were made for hdx_python_country-3.9.5-py3-none-any.whl:

Publisher: publish.yaml on OCHA-DAP/hdx-python-country

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page