Skip to main content

HDX Python country mapping utilities

Project description

Travis-CI Build Status Coveralls Build Status

The HDX Python Country Library provides country mappings including ISO 2 and ISO 3 letter codes (ISO 3166) and regions using live official data from the UNStats M49 website and World Bank api with fallbacks to internal static files if there is any problem with retrieving data from the urls and also for a few special case locations. (Also it is possible to force the use of the internal static files.)

There is a fuzzy matching look up that can handle abbreviations in country names like Dem. for Democratic and Rep. for Republic.

This library is part of the Humanitarian Data Exchange (HDX) project. If you have humanitarian related data, please upload your datasets to HDX.

Usage

The library has detailed API documentation which can be found here: http://ocha-dap.github.io/hdx-python-country/. The code for the library is here: https://github.com/ocha-dap/hdx-python-country.

Countries

The usage of the country mappings functionality is best illustrated by some examples:

from hdx.location.country import Country

Country.get_country_name_from_iso3('jpn', use_live=False)  # returns 'Japan'
# uselive=False forces the use of internal files instead of accessing the live feeds.
# It only needs to be supplied to the first call as the data once loaded is held
# in internal dictionaries for future use.
Country.get_country_name_from_iso2('Pl')  # returns 'Poland'
Country.get_iso3_country_code('UZBEKISTAN')  # returns 'UZB'
Country.get_country_name_from_ison(4)  # returns 'Afghanistan'
Country.get_country_name_from_m49(4)  # returns 'Afghanistan'

Country.get_iso3_country_code_fuzzy('Sierra')
# performs fuzzy match and returns ('SLE', False). The False indicates a fuzzy rather than exact match.
assert Country.get_iso3_country_code_fuzzy('Czech Rep.')
# returns ('CZE', False)

Country.get_country_info_from_iso2('jp')
# {'ISO-alpha2 Code': 'JP', 'ISO-numeric Code': '392', 'Sub-region Name': 'Eastern Asia',
# 'M49 Code': '392', 'ISO-alpha3 Code': 'JPN', 'Developed / Developing Countries': 'Developed',
# 'Land Locked Developing Countries (LLDC)': '', 'Global Name': 'World', 'Region Name': 'Asia',
# 'Least Developed Countries (LDC)': '', 'Intermediate Region Code': '', 'Region Code': '142',
# 'Country or Area': 'Japan', 'Sub-region Code': '030', 'Intermediate Region Name': '',
# 'Small Island Developing States (SIDS)': '', 'Global Code': '001', 'Capital City': 'Tokyo'}

Country.get_countries_in_region('Channel Islands')
# ['GGY', 'JEY']
len(Country.get_countries_in_region('Africa'))
# 60
Country.get_countries_in_region(13)
# ['BLZ', 'CRI', 'GTM', 'HND', 'MEX', 'NIC', 'PAN', 'SLV']

get_countries_in_region accepts regions, intermediate regions or subregions as specified on the UNStats M49 website.

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

Uploaded Source

Built Distribution

hdx_python_country-1.4.7-py2.py3-none-any.whl (98.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file hdx-python-country-1.4.7.tar.gz.

File metadata

  • Download URL: hdx-python-country-1.4.7.tar.gz
  • Upload date:
  • Size: 199.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.1.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.5

File hashes

Hashes for hdx-python-country-1.4.7.tar.gz
Algorithm Hash digest
SHA256 35848998227764d5d9e66fb806e35bbba967cf30a696c9445766a47c80e3c342
MD5 d4817f5be6d0c2d69e2e28fec474a09d
BLAKE2b-256 c5c2aff18ea5aa1e5e767d20152781ad29145f87d12f7bb32a14aca8c82394f8

See more details on using hashes here.

File details

Details for the file hdx_python_country-1.4.7-py2.py3-none-any.whl.

File metadata

  • Download URL: hdx_python_country-1.4.7-py2.py3-none-any.whl
  • Upload date:
  • Size: 98.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.1.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.5

File hashes

Hashes for hdx_python_country-1.4.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 40d0e2d0bd94cb23934da02181d60eb90c41579b5f3820cfb4b9fc7bf912f886
MD5 37f5af0072560222d8e436fb7795956e
BLAKE2b-256 f524d43a9c7fae4c63b1707ac8295fb0c7de8b9c6c2a224f67a951b75302917a

See more details on using hashes here.

Supported by

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