{
"info": {
"author": "sinhrks",
"author_email": "sinhrks@gmail.com",
"bugtrack_url": null,
"classifiers": [],
"description": "pyopendata\n==========\n\n.. image:: https://pypip.in/version/pyopendata/badge.svg\n :target: https://pypi.python.org/pypi/pyopendata/\n :alt: Latest Version\n\n.. image:: https://readthedocs.org/projects/pyopendata/badge/?version=latest\n :target: http://pyopendata.readthedocs.org/en/latest/\n :alt: Latest Docs\n\n.. image:: https://travis-ci.org/sinhrks/pyopendata.svg?branch=master\n :target: https://travis-ci.org/sinhrks/pyopendata\n\nOverview\n~~~~~~~~\n\n``pyopendata`` is a Python utility to offer an unified API to read world various data sources,\nand output ``pandas.DataFrame``. Which covers:\n\n* CKAN websites ( `data.gov `_ , `data.go.jp `_ , etc)\n* `Eurostat `_\n* `OECD `_\n* `WorldBank `_\n\nDocumentation\n~~~~~~~~~~~~~\n\nhttp://pyopendata.readthedocs.org/\n\nInstallation\n~~~~~~~~~~~~\n\n.. code-block:: sh\n\n pip install pyopendata\n\nBasic Usage\n~~~~~~~~~~~\n\nThis section explains how to retrieve data from website which uses CKAN API.You can create ``DataStore`` instance to access CKAN website by passing CKAN URL to ``DataStore`` class.\n\nIn this example, we're going to retrieve the 'California Unemployment Statistics' data from data.gov. The target URL is:\n\n* https://catalog.data.gov/dataset/california-unemployment-statistics/resource/ffd05307-4528-4d15-a370-c16222119227\n\nWe can read above URL as:\n\n * CKAN API URL: https://catalog.data.gov/\n * Package ID: california-unemployment-statistics\n * Resource ID: ffd05307-4528-4d15-a370-c16222119227\n\n.. code-block:: python\n\n >>> import pyopendata as pyod\n\n >>> store = pyod.DataStore('http://catalog.data.gov/')\n >>> store\n CKANStore (http://catalog.data.gov)\n\n``DataStore.serch`` performs search by keyword. Results will be the list of packages. You can select a target package by slicing.\n\n.. code-block:: python\n\n >>> packages = store.search('Unemployment Statistics')\n >>> packages\n [annual-survey-of-school-system-finances (1 resource),\n current-population-survey (1 resource),\n federal-aid-to-states (1 resource),\n current-population-survey-labor-force-statistics (2 resources),\n dataferrett (1 resource),\n mass-layoff-statistics (1 resource),\n unemployment-rate (3 resources),\n consolidated-federal-funds-report (1 resource),\n annual-survey-of-state-and-local-government-finances (1 resource),\n local-area-unemployment-statistics (2 resources)]\n\n >>> packages[0]\n annual-survey-of-school-system-finances (1 resource)\n\n\nOtherwise, specify the package name to be retrieved.\n\n.. code-block:: python\n\n >>> package = store.get('california-unemployment-statistics')\n >>> package\n california-unemployment-statistics (4 resources)\n\nA package has resources (files) which contains actual data. You use `get` method to retrieve the resource.\n\n.. code-block:: python\n\n >>> resource = package.get('ffd05307-4528-4d15-a370-c16222119227')\n >>> resource\n Resource ID: ffd05307-4528-4d15-a370-c16222119227\n Resource Name: Comma Separated Values File\n Resource URL: https://data.lacity.org/api/views/5zrb-xqhf/rows.csv?accessType=DOWNLOAD\n Format: CSV, Size: None\n\n\nOnce you get the resource, use ``read`` method to read data as pandas ``DataFrame``.\n\n.. important:: The target file must be the correct format which can be parsed by ``pandas`` IO functions.\n\n.. code-block:: python\n\n >>> df = resource.read()\n >>> df.head()\n Year Period Area Unemployment Rate Labor Force \\\n 0 2013 Jan California 10.4% 18556500\n 1 2013 Jan Los Angeles County 10.9% 4891500\n 2 2013 Jan Los Angeles City 12% 1915600\n 3 2013 Feb California 9.699999999999999% 18648300\n 4 2013 Feb Los Angeles County 10.3% 4924000\n\n Employment Unemployment Adjusted Preliminary\n 0 16631900 1924600 Not Adj Not Prelim\n 1 4357800 533800 Not Adj Not Prelim\n 2 1684800 230800 Not Adj Not Prelim\n 3 16835900 1812400 Not Adj Not Prelim\n 4 4418000 506000 Not Adj Not Prelim\n\n\nOr you can get raw data by specifying ``raw=True``.\n\n.. code-block:: python\n\n >>> raw = resource.read(raw=True)\n >>> raw[:100]\n 'Year,Period,Area,Unemployment Rate,Labor Force,Employment,Unemployment,Adjusted,Preliminary\\n2013,Jan'",
"description_content_type": null,
"docs_url": null,
"download_url": "UNKNOWN",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "http://pyopendata.readthedocs.org",
"keywords": null,
"license": "BSD",
"maintainer": null,
"maintainer_email": null,
"name": "pyopendata",
"package_url": "https://pypi.org/project/pyopendata/",
"platform": "UNKNOWN",
"project_url": "https://pypi.org/project/pyopendata/",
"project_urls": {
"Download": "UNKNOWN",
"Homepage": "http://pyopendata.readthedocs.org"
},
"release_url": "https://pypi.org/project/pyopendata/0.0.3/",
"requires_dist": null,
"requires_python": null,
"summary": "Python utility to get open data from some popular websites",
"version": "0.0.3"
},
"last_serial": 1425306,
"releases": {
"0.0.1": [
{
"comment_text": "",
"digests": {
"md5": "24c20cd12201375660556b41767fbf9b",
"sha256": "288a806e4b821c0f07794076a843df143d38797ef465db4078cefae32d019fff"
},
"downloads": -1,
"filename": "pyopendata-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "24c20cd12201375660556b41767fbf9b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18303,
"upload_time": "2014-10-05T04:11:27",
"url": "https://files.pythonhosted.org/packages/b8/e4/0f10170b67e81804f6592cb5b965bd88c01903509946dfd978c64ddc2b33/pyopendata-0.0.1.tar.gz"
}
],
"0.0.2": [
{
"comment_text": "",
"digests": {
"md5": "5dc897984a5e7db9adb97af55c5a9c7a",
"sha256": "5a2cf9f8d86273d8f443ce938b9e7c7be6c5807de11577709704ba2921f4d4cb"
},
"downloads": -1,
"filename": "pyopendata-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "5dc897984a5e7db9adb97af55c5a9c7a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28253,
"upload_time": "2014-10-19T13:52:04",
"url": "https://files.pythonhosted.org/packages/6c/a4/5a21d96b0344987bb3ae892de15d84bc582107a1cb43c1ba18cfb1911b5f/pyopendata-0.0.2.tar.gz"
}
],
"0.0.3": [
{
"comment_text": "",
"digests": {
"md5": "96762a73bcc8db1329f0105b4d6409ef",
"sha256": "88af960f76269ced9f1c034ecd5be90a640ae3a515a487e07fd6de82e12278f0"
},
"downloads": -1,
"filename": "pyopendata-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "96762a73bcc8db1329f0105b4d6409ef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11979,
"upload_time": "2015-02-16T12:32:59",
"url": "https://files.pythonhosted.org/packages/3f/9e/66353403e163fc1406d7ce0b1cfc02972540435d2bfd9713a4f207b982ab/pyopendata-0.0.3.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "96762a73bcc8db1329f0105b4d6409ef",
"sha256": "88af960f76269ced9f1c034ecd5be90a640ae3a515a487e07fd6de82e12278f0"
},
"downloads": -1,
"filename": "pyopendata-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "96762a73bcc8db1329f0105b4d6409ef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11979,
"upload_time": "2015-02-16T12:32:59",
"url": "https://files.pythonhosted.org/packages/3f/9e/66353403e163fc1406d7ce0b1cfc02972540435d2bfd9713a4f207b982ab/pyopendata-0.0.3.tar.gz"
}
]
}