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 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.)

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_partial('Sierra')
# performs partial match and returns ('SLE', 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

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

Uploaded Source

Built Distribution

hdx_python_country-1.0.4-py2.py3-none-any.whl (80.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for hdx-python-country-1.0.4.tar.gz
Algorithm Hash digest
SHA256 cc3dc8592925cbfee7018708823b85d798f354151dcfded76faba1ef69252264
MD5 9e1f0e2f0a5eb4059aea79fa3c187c66
BLAKE2b-256 07429c6ba55a664dc634f91843801012a1a1f0042c0730508530c759b1b8eb7b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for hdx_python_country-1.0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 47ee1737a16508b0f8cb7d036e9c37967cfe09f582b622dfde5a3b7fae9eaa6b
MD5 6b9cbaa996c853cdd62913ac13febadd
BLAKE2b-256 cf5fde4f4331229b080f5aa2f8d742813e27e7635d30b419dd342b697b91105b

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