pyopendata package

Submodules

pyopendata.base module

class pyopendata.base.DataResource(format=None, id=None, name=None, url=None, proxies=None, size=None, **kwargs)

Bases: pandas.core.base.StringMixin

Represents a data contained in the URL

read(raw=False, **kwargs)

Read data from resource

raw : bool, default False
If False, return pandas.DataFrame. If True, return raw data
kwargs:
Keywords passed to pandas.read_xxx function

data : pandas.DataFrame or requests.raw.data

  • Depending on the target format, parsing to pandas.DataFrame may fail. Use raw=True to get raw data in such cases.
class pyopendata.base.DataStore(kid_or_url=None, proxies=None)

Bases: pyopendata.base.DataResource

datasets
get(name)

Get resource by resource_id.

resource_id : str
id to specify resource

result : DataResource

is_valid()

Check whether the site has valid API.

is_valid : bool

search(serch_string)

Search resources by search_string.

search storing : str
keyword to search

result : list of DataResource

pyopendata.ckan module

class pyopendata.ckan.CKANPackage(_store=None, resources=None, name=None, **kwargs)

Bases: pyopendata.base.DataResource

get(resource_id)

Get resource by resource_id.

resource_id : str
id to specify resource

result : CKANResource

get_resource(resource_id)

Get resource by resource_id.

resource_id : str
id to specify resource

result : CKANResource

read(raw=False, **kwargs)

Read data from its resource if the number of resource is 1. Otherwise, raise ValueError.

raw : bool, default False
If False, return pandas.DataFrame. If True, return raw data
kwargs:
Keywords passed to pandas.read_xxx function

data : pandas.DataFrame or requests.raw.data

resources
class pyopendata.ckan.CKANResource(_store=None, resources=None, **kwargs)

Bases: pyopendata.base.DataResource

read(raw=False, **kwargs)

Read data from resource

raw : bool, default False
If False, return pandas.DataFrame. If True, return raw data
kwargs:
Keywords passed to pandas.read_xxx function

data : pandas.DataFrame or requests.raw.data

  • Depending on the target format, parsing to pandas.DataFrame may fail. Use raw=True to get raw data in such cases.
class pyopendata.ckan.CKANStore(kid_or_url=None, proxies=None)

Bases: pyopendata.base.DataStore

Storage class to read data via CKAN API

url : string
URL for CKAN API
datasets
get(object_id)

Get instance related to object_id. First try to get_resource, then get_package.

object_id : str
id to specify resource or package

result : CKANResouce or CKANPackage

get_package(package_id)

Get package related to package_id.

package_id : str
id to specify package

result : CKANPackage

get_packages_from_group(group_id)
get_resource(resource_id)

Get resource by resource_id.

resource_id : str
id to specify resource

result : CKANResource

get_resources_from_tag(tag)
groups
is_valid()

Check whether the site has valid API.

is_valid : bool

packages
search(search_string)

Search resources by search_string.

search storing : str
keyword to search

result : list of CKANResource

search_package(search_string)
search_resource(search_string)
tags

pyopendata.eurostat module

class pyopendata.eurostat.EurostatResource(**kwargs)

Bases: pyopendata.base.DataResource

dsd
class pyopendata.eurostat.EurostatStore(kid_or_url=None, proxies=None)

Bases: pyopendata.base.DataStore

Storage class to read Eurostat data

datasets
get(data_id)

Get resource by resource_id.

resource_id : str
id to specify resource

result : EurostatResource

pyopendata.oecd module

class pyopendata.oecd.OECDResource(format=None, id=None, name=None, url=None, proxies=None, size=None, **kwargs)

Bases: pyopendata.base.DataResource

class pyopendata.oecd.OECDStore(kid_or_url=None, proxies=None)

Bases: pyopendata.base.DataStore

Storage class to read OECD data

get(resource_id)

Get resource by resource_id.

resource_id : str
id to specify resource

result : OECDResource

pyopendata.undata module

class pyopendata.undata.UNdataResource(**kwargs)

Bases: pyopendata.base.DataResource

class pyopendata.undata.UNdataStore(kid_or_url=None, proxies=None)

Bases: pyopendata.base.DataStore

Storage class to read UNdata data

datasets
get(data_id)
is_valid()

Check whether the site has valid API.

is_valid : bool

pyopendata.version module

pyopendata.worldbank module

class pyopendata.worldbank.WorldBankResource(format=None, id=None, name=None, url=None, proxies=None, size=None, **kwargs)

Bases: pyopendata.base.DataResource

entries_per_page = 500
class pyopendata.worldbank.WorldBankStore(kid_or_url=None, proxies=None)

Bases: pyopendata.base.DataStore

Storage class to read World Bank data

get(resource_id)

Get resource by resource_id.

resource_id : str
id to specify resource

result : WorldBankResource

Module contents