{
    "info": {
        "author": "Chris Brown",
        "author_email": "cebrown999@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Intended Audience :: Developers",
            "Intended Audience :: Science/Research",
            "License :: OSI Approved :: MIT License",
            "Natural Language :: English",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7",
            "Topic :: Scientific/Engineering :: Physics"
        ],
        "description": "\n# eiapy\n[![PyPI](https://img.shields.io/pypi/v/eiapy.svg)](https://pypi.org/project/eiapy/) [![PyPI - License](https://img.shields.io/pypi/l/eiapy.svg)](https://pypi.org/project/eiapy/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/eiapy.svg)](https://pypi.org/project/eiapy/)  \n\nPython 3 wrapper for the U.S. Energy Information Administration API.  \n\n### Quick start\n```bash\npip install eiapy\n```\n\nGet the last 5 measurements of the electricity flow between California and Mexico.\n\n```python3\n>>> from eiapy import Series\n>>> cal_to_mex = Series('EBA.CISO-CFE.ID.H')\n>>> cal_to_mex.last(5)\n{'request': {'command': 'series', 'series_id': 'EBA.CISO-CFE.ID.H'},\n 'series': [{'data': [['20180401T07Z', -11],\n                      ['20180401T06Z', -16],\n                      ['20180401T05Z', -11],\n                      ['20180401T04Z', -7],\n                      ['20180401T03Z', -5]],\n             'description': 'Timestamps follow the ISO8601 standard '\n                            '(https://en.wikipedia.org/wiki/ISO_8601). Hourly '\n                            'representations are provided in Universal Time.',\n             'end': '20180401T07Z',\n             'f': 'H',\n             'name': 'Actual Net Interchange for California Independent System '\n                     'Operator (CISO) to Comision Federal de Electricidad '\n                     '(CFE), Hourly',\n             'series_id': 'EBA.CISO-CFE.ID.H',\n             'start': '20150701T00Z',\n             'units': 'megawatthours',\n             'updated': '2018-04-02T08:43:16-0400'}]}\n\n```\n\nFurther examples can be found [in this gist](https://gist.github.com/systemcatch/019cf50302093b9b51838c62b99623df).\n\nTo find more details about the API go to the EIA's [Open Data](https://www.eia.gov/opendata/) page. To find interesting data (and identifiers) [browse the data sets](https://www.eia.gov/opendata/qb.php).\n\nFor specific information about the [real-time grid display](https://www.eia.gov/beta/electricity/gridmonitor/dashboard/electric_overview/US48/US48) please see [this guide](https://www.eia.gov/realtime_grid/docs/userguide-knownissues.pdf).\n\nGo [here](https://www.eia.gov/opendata/register.cfm#terms_of_service) to see the\nAPI terms of service and [here](https://www.eia.gov/about/copyrights_reuse.cfm)\nfor an explanation of copyright and reuse of their data.\n\n### Setting up your API key\nAn API key is needed to access the EIA's data, you can get one [here](https://www.eia.gov/opendata/register.php). eiapy needs this key to be manually set in the operating system environmental variables.\n\n**Mac & Linux**  \nOpen a terminal and enter the following;\n```bash\nexport EIA_KEY=type_your_api_key_here\n```\nTo set it permanently follow the instructions on this [stackexchange question](https://unix.stackexchange.com/questions/117467/how-to-permanently-set-environmental-variables).\n\n**Windows**  \nOpen a Command Prompt and enter the following;\n```bat\nsetx EIA_KEY \"type_your_api_key_within_the_quotes\"\n```\n\n### Notes on API behaviour\n- When providing invalid time limits for a series data request an empty data list is returned.\n- For data requests num & start cannot be used together but num & end can.\n- When an invalid series id is passed this is the response.\n```python3\n{'request': {'series_id': 'eba.ciso-cfe.id.', 'command': 'series', 'num': '5'},\n 'data': {'error': 'invalid series_id. For key registration, documentation, and\n examples see https://www.eia.gov/developer/'}}\n```\n\n### Changelog\n**0.1.4**\n- Fixed broken Search `repr`.\n- Added Python 3.7 to supported versions.\n- Mention real-time grid in readme.\n\n**0.1.3**\n- Simplify construction and use of the Search class.\n- Explain how to set up the API key.\n- Added gist of examples to readme.\n\n**0.1.2**\n- Rename several methods for extra clarity.\n- data -> get_data\n- get -> get_updates\n\n**0.1.1**  \n- Started using requests session functionality to improve performance.\n- Fixed a mistake in the MultiSeries class that stopped it working entirely.\n- Added a version attribute to the package.\n- Overhaul of readme.\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/systemcatch/eiapy",
        "keywords": "EIA Data API Energy",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "eiapy",
        "package_url": "https://pypi.org/project/eiapy/",
        "platform": "",
        "project_url": "https://pypi.org/project/eiapy/",
        "project_urls": {
            "Homepage": "https://github.com/systemcatch/eiapy"
        },
        "release_url": "https://pypi.org/project/eiapy/0.1.4/",
        "requires_dist": [
            "requests"
        ],
        "requires_python": ">=3",
        "summary": "A simple wrapper for the EIA API.",
        "version": "0.1.4"
    },
    "last_serial": 5862330,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "5746843949d860214949232a4e9da143",
                    "sha256": "9baca309c439065231f722b98587792a2cd70411d0f1ab30079c2c307e3e1f84"
                },
                "downloads": -1,
                "filename": "eiapy-0.1.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "5746843949d860214949232a4e9da143",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">=3",
                "size": 5499,
                "upload_time": "2018-05-11T21:26:37",
                "url": "https://files.pythonhosted.org/packages/30/e7/15e2e4319ffd3069410056af0bad55fad806cba9f605d9e2f5eb6fb3508b/eiapy-0.1.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "0b3c1652c5f8dfce2d8fb058d8647799",
                    "sha256": "a835f08b7c41361e59beb662f7fb42df1474e1819340ed5ea7fd3480b9bc3603"
                },
                "downloads": -1,
                "filename": "eiapy-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "0b3c1652c5f8dfce2d8fb058d8647799",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3",
                "size": 5450,
                "upload_time": "2018-05-11T21:26:38",
                "url": "https://files.pythonhosted.org/packages/e2/a9/01bdc0aa522ab619de07da438d0c8c58737b3e3af40a8e889522ef0f108e/eiapy-0.1.0.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "43b6178e6ab86d6d6eb7660b257ff3a7",
                    "sha256": "47aa3477ef7a12ba2e34a8372085e4c3daad2c28c5086ac81ec673da74f378e5"
                },
                "downloads": -1,
                "filename": "eiapy-0.1.1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "43b6178e6ab86d6d6eb7660b257ff3a7",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">=3",
                "size": 5671,
                "upload_time": "2018-05-16T21:39:38",
                "url": "https://files.pythonhosted.org/packages/37/e7/fc6ff8c4ba9ab895c6cebf0342553ff603b563d151c8edad5564bcfed8c4/eiapy-0.1.1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "cf0ddfd13f8e34dd5c7fdad83c6b304b",
                    "sha256": "5a014515bc88a35f5441f9c8eb72d55a3e62beb2c0d33cf45af96ca2ad5d5643"
                },
                "downloads": -1,
                "filename": "eiapy-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "cf0ddfd13f8e34dd5c7fdad83c6b304b",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3",
                "size": 5630,
                "upload_time": "2018-05-16T21:39:40",
                "url": "https://files.pythonhosted.org/packages/bb/18/ddb2097e1fd5571079ecd1ff59b52a31d882b871c6a21827468c5d2f0f54/eiapy-0.1.1.tar.gz"
            }
        ],
        "0.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "174cd39dd0f3403e1947d140cb916c86",
                    "sha256": "f56d7486c9ed71875fe577187084f886c094077fe065521789c8139e4e8d3125"
                },
                "downloads": -1,
                "filename": "eiapy-0.1.2-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "174cd39dd0f3403e1947d140cb916c86",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">=3",
                "size": 5690,
                "upload_time": "2018-05-19T18:04:21",
                "url": "https://files.pythonhosted.org/packages/c0/13/e7ecd61eb521a993da9e17b5525d98c540b1346ffb4a6bc70a5416b862f8/eiapy-0.1.2-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "6dcfeee239730932efb6198ccdc90b57",
                    "sha256": "274578824ffca364bf356e63161dd58df98cf5a874cb4d2eeb35a9d2cb703cbe"
                },
                "downloads": -1,
                "filename": "eiapy-0.1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "6dcfeee239730932efb6198ccdc90b57",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3",
                "size": 5662,
                "upload_time": "2018-05-19T18:04:22",
                "url": "https://files.pythonhosted.org/packages/32/13/35aa6eb263752eb500e4d196a251e479150287ddaef0b23662314c741d2a/eiapy-0.1.2.tar.gz"
            }
        ],
        "0.1.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "542afafa32f7415e051ce7805df99389",
                    "sha256": "ff2203cfdd7b3953afdf0174046c1ec4d9c6b83467087e62ff5d99428f333142"
                },
                "downloads": -1,
                "filename": "eiapy-0.1.3-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "542afafa32f7415e051ce7805df99389",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">=3",
                "size": 6151,
                "upload_time": "2018-12-07T13:39:51",
                "url": "https://files.pythonhosted.org/packages/10/74/fba3d31b91992d8a1aa40b00086cdb7e38f1494d7099c47f7ac052ad018d/eiapy-0.1.3-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "721e0c99c38e6dd48764cd64b729e7db",
                    "sha256": "fd33f4598e41a949ea67bf631caabb4a0ed6c4cfb7ff763a9c29724c1cb0094f"
                },
                "downloads": -1,
                "filename": "eiapy-0.1.3.tar.gz",
                "has_sig": false,
                "md5_digest": "721e0c99c38e6dd48764cd64b729e7db",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3",
                "size": 6223,
                "upload_time": "2018-12-07T13:39:53",
                "url": "https://files.pythonhosted.org/packages/64/ed/d99e61e3963b5e58cf698812351115818bd90e075473353ed6678813a4ff/eiapy-0.1.3.tar.gz"
            }
        ],
        "0.1.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "474046f577f35947b86ab26280d7a9a0",
                    "sha256": "e4d5ed8ae2bebb31ff3afb04f354d2dd7b23c1e40f409e231458c6d56ecccaf5"
                },
                "downloads": -1,
                "filename": "eiapy-0.1.4-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "474046f577f35947b86ab26280d7a9a0",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">=3",
                "size": 6255,
                "upload_time": "2019-09-20T13:31:35",
                "url": "https://files.pythonhosted.org/packages/ae/b5/7769d5145d05736b643d9419dd278a842d6dfc14e7ce9914ab20a1fefeee/eiapy-0.1.4-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "8088df4b9395c638f6c75a1e3d79df65",
                    "sha256": "8ca107ee2d03812fccc42f8e6c2cfab1aaa548a52a3ab838b6ed5807b7f74f05"
                },
                "downloads": -1,
                "filename": "eiapy-0.1.4.tar.gz",
                "has_sig": false,
                "md5_digest": "8088df4b9395c638f6c75a1e3d79df65",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3",
                "size": 6375,
                "upload_time": "2019-09-20T13:31:37",
                "url": "https://files.pythonhosted.org/packages/1f/5a/649bd3eb30f97d0776931b56a50f96f3b8e29f0f6702759a0392acd9e717/eiapy-0.1.4.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "474046f577f35947b86ab26280d7a9a0",
                "sha256": "e4d5ed8ae2bebb31ff3afb04f354d2dd7b23c1e40f409e231458c6d56ecccaf5"
            },
            "downloads": -1,
            "filename": "eiapy-0.1.4-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "474046f577f35947b86ab26280d7a9a0",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3",
            "size": 6255,
            "upload_time": "2019-09-20T13:31:35",
            "url": "https://files.pythonhosted.org/packages/ae/b5/7769d5145d05736b643d9419dd278a842d6dfc14e7ce9914ab20a1fefeee/eiapy-0.1.4-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "8088df4b9395c638f6c75a1e3d79df65",
                "sha256": "8ca107ee2d03812fccc42f8e6c2cfab1aaa548a52a3ab838b6ed5807b7f74f05"
            },
            "downloads": -1,
            "filename": "eiapy-0.1.4.tar.gz",
            "has_sig": false,
            "md5_digest": "8088df4b9395c638f6c75a1e3d79df65",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3",
            "size": 6375,
            "upload_time": "2019-09-20T13:31:37",
            "url": "https://files.pythonhosted.org/packages/1f/5a/649bd3eb30f97d0776931b56a50f96f3b8e29f0f6702759a0392acd9e717/eiapy-0.1.4.tar.gz"
        }
    ]
}