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. (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_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')
# {'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'}

Country.get_countries_in_region('Channel Islands')
# ['GGY', 'JEY']
len(Country.get_countries_in_region('Africa'))
# 60
Country.get_countries_in_region('013')
# ['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

This version

1.0.7

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hdx_python_country-1.0.7-py2.py3-none-any.whl (81.1 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for hdx-python-country-1.0.7.tar.gz
Algorithm Hash digest
SHA256 cec11c1c74b77bf63f3469d4ac5693775ca0774b9d3272b4974fc557286de41e
MD5 35ff2fd60176bf9e2699f7197436d2c1
BLAKE2b-256 be4cbdbf1e2d006540ed6b884d0236988131211a31ef1b4c075fc2da7853836b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for hdx_python_country-1.0.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a28be1b047189b66ba9fc3142636eed80f47e5806a58d479e8754a1929c64c67
MD5 bb11cb75f654e48a1ce0d2b86767d9c1
BLAKE2b-256 5a3f72ebcfc1fb158b6e7e9f2776018106fefb7175bc07b68207018026292a97

See more details on using hashes here.

Supported by

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