HDX Python country code and exchange rate (fx) utilities

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for mcarans from gravatar.com mcarans

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License (MIT)
  • Author: Michael Rans
  • Tags HDX , country , country code , currencies , currency , exchange rate , foreign exchange , fx , iso 3166 , iso2 , iso3 , location , region
  • Requires: Python >=3.8
  • Provides-Extra: dev , docs , test
Classifiers
Report project as malware

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

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for mcarans from gravatar.com mcarans

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License (MIT)
  • Author: Michael Rans
  • Tags HDX , country , country code , currencies , currency , exchange rate , foreign exchange , fx , iso 3166 , iso2 , iso3 , location , region
  • Requires: Python >=3.8
  • Provides-Extra: dev , docs , test
Classifiers

Release history Release notifications | RSS feed

This version

3.9.6

3.9.5

3.9.4

3.9.3

3.9.2

3.9.1

3.9.0

3.8.9

3.8.8

3.8.7

3.8.6

3.8.5

3.8.4

3.8.3

3.8.2

3.8.1

3.8.0

3.7.9

3.7.8

3.7.7

3.7.6

3.7.5

3.7.4

3.7.3

3.7.2

3.7.1

3.7.0

3.6.9

3.6.8

3.6.7

3.6.6

3.6.5

3.6.4

3.6.3

3.6.2

3.6.1

3.6.0

3.5.9

3.5.8

3.5.7

3.5.6

3.5.5

3.5.4

3.5.3

3.5.2

3.5.1

3.5.0

3.4.9

3.4.8

3.4.7

3.4.6

3.4.5

3.4.4

3.4.3

3.4.2

3.4.1

3.4.0

3.3.9

3.3.8

3.3.7

3.3.6

3.3.5

3.3.4

3.3.3

3.3.2

3.3.1

3.3.0

3.2.9

3.2.8

3.2.7

3.2.6

3.2.5

3.2.4

3.2.3

3.2.2

3.2.1

3.2.0

3.1.9

3.1.8

3.1.7

3.1.6

3.1.5

3.1.4

3.1.3

3.1.2

3.1.1

3.1.0

3.0.9

3.0.8

3.0.7

3.0.6

3.0.5

3.0.4

3.0.2

3.0.1

3.0.0

2.9.9

2.9.8

2.9.7

2.9.6

2.9.5

2.9.4

2.9.3

2.9.2

2.9.1

2.9.0

2.8.9

2.8.8

2.8.7

2.8.6

2.8.5

2.8.4

2.8.3

2.8.2

2.8.1

2.8.0

2.7.9

2.7.8

2.7.7

2.7.6

2.7.5

2.7.4

2.7.3

2.7.2

2.7.1

2.7.0

2.6.8

2.6.7

2.6.6

2.6.5

2.6.4

2.6.3

2.6.2

2.6.1

2.6.0

2.5.9

2.5.8

2.5.7

2.5.6

2.5.5

2.5.4

2.5.3

2.5.2

2.5.1

2.5.0

2.4.9

2.4.8

2.4.7

2.4.6

2.4.5

2.4.4

2.4.3

2.4.2

2.4.1

2.4.0

2.3.9

2.3.8

2.3.7

2.3.6

2.3.5

2.3.4

2.3.3

2.3.2

2.3.1

2.3.0

2.2.9

2.2.8

2.2.7

2.2.6

2.2.5

2.2.4

2.2.3

2.2.2

2.2.1

2.2.0

2.1.9

2.1.8

2.1.7

2.1.6

2.1.5

2.1.4

2.1.3

2.1.2

2.1.1

2.1.0

2.0.9

2.0.8

2.0.7

2.0.6

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

1.5.6

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.9

1.4.8

1.4.7

1.4.6

1.4.5

1.4.4

1.4.3

1.4.2

1.4.1

1.4.0

1.3.9

1.3.8

1.3.7

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.9

1.2.8

1.2.7

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.9

1.1.8

1.1.7

1.1.6

1.1.5

1.1.4

1.1.3

1.1.2

1.1.1

1.1.0

1.0.9

1.0.7

1.0.6

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0

0.5.1

0.5

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.6.tar.gz (529.2 kB view details)

Uploaded Source

Built Distribution

hdx_python_country-3.9.6-py3-none-any.whl (55.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hdx_python_country-3.9.6.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.6.tar.gz
Algorithm Hash digest
SHA256 7791f4b9c5ae3e62e82795c266a3ca6ee23c7bab706c91533844edf2ebd9bb18
MD5 8c9a62ab07a906fe7549e288e96be71e
BLAKE2b-256 8896ac55b204699cd216a22a943f64aafac32bba818f624a5d44879d60368fad

See more details on using hashes here.

Provenance

The following attestation bundles were made for hdx_python_country-3.9.6.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.6-py3-none-any.whl.

File metadata

File hashes

Hashes for hdx_python_country-3.9.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4c1833bdf3cbd14dfff0146e0bdcae5763931d344fce5f1b42493dc8751e3d4a
MD5 a946827b3f54c4957fe7f0aca3349dc6
BLAKE2b-256 4590646b56ec12df459799510d6d0869ada210ad9f765ad104e50dae4867eb50

See more details on using hashes here.

Provenance

The following attestation bundles were made for hdx_python_country-3.9.6-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