unesco-reader 3.1.1

Pythonic access to UNESCO data

unesco_reader

Pythonic access to UNESCO data

unesco_reader provides simple and convenient access to data published by the UNESCO Institute of Statistics (UIS). It offers a simple wrapper for the UIS API endpoints, and offers added convenience including error handling, filtering ability, and basic pandas support.

Note: As of version v3.0.0 the package does not support access to bulk data files. Previous versions of the package were developed before the release of the API and offered support for accessing the bulk data files. This functionality has been deprecated in favor of the API for programmatic access to the data. To access bulk data files, please visit the bulk data download page.

Installation

$ pip install unesco-reader

Simple Usage

Import the package:

import unesco_reader as uis

Get data for an indicator and geo unit:

df = uis.get_data("CR.1", "ZWE")

At least a country or an indicator must be requested. Currently, there is a 100,000 record limit for the API response. If this limit is exceeded an error is raised. To request more data, please make multiple requests with fewer parameters.

Get data with additional fields like indicator and geo unit names, and footnotes:

df = uis.get_data("CR.1", "ZWE", footnotes=True, labels=True)

Get metadata for an indicator:

metadata = uis.get_metadata("CR.1")

Get metadata with disaggregations and glossary terms:

metadata = uis.get_metadata("CR.1", disaggregations=True, glossaryTerms=True)

Get available indicators:

indicators = uis.available_indicators()

Get available indicators for a specific theme and with data starting at least in 2010:

indicators = uis.available_indicators(theme="EDUCATION", minStart=2010)

Get available geo units:

geo_units = uis.available_geo_units()

Get available regional geo units:

geo_units = uis.available_geo_units(geoUnitType="REGIONAL")

Get available themes:

themes = uis.available_themes()

Get available data versions:

versions = uis.available_versions()

Get the default data version:

default_version = uis.default_version()

Caching

The UIS API includes caching logic. This package also includes in memory caching for API definition endpoints (indicators, geo units, and versions) for the lifetime of the session. This avoids redundant network requests when making multiple queries. To manually clear the cache (e.g. to pick up newly published data versions mid-session):

uis.clear_cache()

Data requests (get_data) are never cached and always fetch fresh results from the API (which may be cached by the API itself, depending on the endpoint and parameters).

Retry Configuration

By default, transient network errors are retried once. To change the number of retries:

uis.set_max_retries(3)  # retry up to 3 times
uis.set_max_retries(0)  # disable retries

Rate Limiting and Asynchronous Support

There are currently no API rate limits, but there is a 100,000 record limit for each request. This package does not use any multithreading or chunking responses, to maintain the APIs recommended usage. Aggregated flat file data can be accessed through the Bulk Data Download page.

Basic wrapper usage

unesco_reader offers out-of-the-box convenience for accessing data through the UIS API. If you need more control, you can access the thin wrapper around the API endpoint through the api module.

Contributing

All contributions are welcome! If you find a bug, or have a suggestion for a new feature, or an improvement on the documentation please open an issue. Since this project is under current development, please check open issues and make sure the issue has not been raised already.

A detailed overview of the contribution process can be found here. By contributing to this project, you agree to abide by its terms.

License

unesco_reader was created by Luca Picci. It is licensed under the terms of the MIT license.