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

Uploaded Source

Built Distribution

hdx_python_country-1.0.1-py2.py3-none-any.whl (10.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for hdx-python-country-1.0.1.tar.gz
Algorithm Hash digest
SHA256 e17fbfaf9f235567a5d23e75b0da9ae5a5e9550fc05bac865f3f528d2c2f61cf
MD5 12d2d44e284f8086ba6364c852e35215
BLAKE2b-256 d162fadb49fd04741dfa99a47b5368a5a981f2bce470199f59f317b150cf71f1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for hdx_python_country-1.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 43bf561fc8d97fd58378b6a95fadcbf151a6943575983c2d057e5db3628ee198
MD5 98b30ca1a35e1c0352df792c781e0a5a
BLAKE2b-256 2b80f3a92850830c2d1bf8d201d5ec32b2fff3b0f42451817fef97f37a981ea1

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