# A Python library to download preprocessed data from the ESIOS API (REE)
ESIOS API is a service provided by the Spanish electricity system operator (REE) that offers access to a wide range of data related to the electricity market in Spain.
This library provides a simple interface to download and preprocess the data from the ESIOS API.
## Install library
```shell
pip install python-esios
```
## Get token
Ask for a personal token to access the ESIOS API following the [instructions from REE](https://www.esios.ree.es/es/pagina/api).
## Usage
### Register the token in Python
```python
TOKEN = '343sdfewe342309gjarijgwoiret834383434524...'
TOKEN = '<YOUR_TOKEN>'
```
Then, set the token in the environment variable `ESIOS_API_KEY`.
```python
import os
os.environ['ESIOS_API_KEY'] = TOKEN
```
### Instantiate the client
```python
from esios import ESIOSClient
client = ESIOSClient()
```
### Access the endpoint
```python
endpoint = client.endpoint(name=?)
```
In the tutorials below, you will learn how to download, preprocess, and visualize the data from the following endpoints:
- [Indicators](https://github.com/datons/python-esios/blob/main/examples/30_Indicators/0_Steps/B1_Download.ipynb)
- [Archives](https://github.com/datons/python-esios/blob/main/examples/20_Archives/0_Steps/B1_Download.ipynb)
Raw data
{
"_id": null,
"home_page": "https://github.com/datons/python-esios",
"name": "python-esios",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Jes\u00fas L\u00f3pez",
"author_email": "jesus.lopez@datons.ai",
"download_url": "https://files.pythonhosted.org/packages/9e/a8/58e4ae10adc949e7f4cf49545e92d61040592db1b3d61a99b7dc78fe3798/python_esios-0.2.6.tar.gz",
"platform": null,
"description": "# A Python library to download preprocessed data from the ESIOS API (REE)\n\nESIOS API is a service provided by the Spanish electricity system operator (REE) that offers access to a wide range of data related to the electricity market in Spain.\n\nThis library provides a simple interface to download and preprocess the data from the ESIOS API.\n\n## Install library\n\n```shell\npip install python-esios\n```\n\n## Get token\n\nAsk for a personal token to access the ESIOS API following the [instructions from REE](https://www.esios.ree.es/es/pagina/api).\n\n## Usage\n\n### Register the token in Python\n\n```python\nTOKEN = '343sdfewe342309gjarijgwoiret834383434524...'\nTOKEN = '<YOUR_TOKEN>'\n```\n\nThen, set the token in the environment variable `ESIOS_API_KEY`.\n\n```python\nimport os\nos.environ['ESIOS_API_KEY'] = TOKEN\n```\n\n### Instantiate the client\n\n```python\nfrom esios import ESIOSClient\nclient = ESIOSClient()\n```\n\n### Access the endpoint\n\n```python\nendpoint = client.endpoint(name=?)\n```\n\nIn the tutorials below, you will learn how to download, preprocess, and visualize the data from the following endpoints:\n\n- [Indicators](https://github.com/datons/python-esios/blob/main/examples/30_Indicators/0_Steps/B1_Download.ipynb)\n- [Archives](https://github.com/datons/python-esios/blob/main/examples/20_Archives/0_Steps/B1_Download.ipynb)\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python wrapper for the ESIOS API",
"version": "0.2.6",
"project_urls": {
"Homepage": "https://github.com/datons/python-esios"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d536425e96a99595c6ee3c9b1c471545c4899587bb796ae4865e45565b342678",
"md5": "c0abb7ad34fdcdd76f83ab1d0075d4fd",
"sha256": "e0299d4f789293244439b1e657abca3948a0e78bef3f218cb83d64cfb743cba5"
},
"downloads": -1,
"filename": "python_esios-0.2.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c0abb7ad34fdcdd76f83ab1d0075d4fd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 19604,
"upload_time": "2024-12-14T08:08:27",
"upload_time_iso_8601": "2024-12-14T08:08:27.308322Z",
"url": "https://files.pythonhosted.org/packages/d5/36/425e96a99595c6ee3c9b1c471545c4899587bb796ae4865e45565b342678/python_esios-0.2.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9ea858e4ae10adc949e7f4cf49545e92d61040592db1b3d61a99b7dc78fe3798",
"md5": "1bf70fd15e972dbbbdedb3b348dc2b7a",
"sha256": "69e5fd4ff1026f9aafe62d2832dd8cf56d7d8dc732f098f8fe4b77fa4f15af63"
},
"downloads": -1,
"filename": "python_esios-0.2.6.tar.gz",
"has_sig": false,
"md5_digest": "1bf70fd15e972dbbbdedb3b348dc2b7a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 17780,
"upload_time": "2024-12-14T08:08:29",
"upload_time_iso_8601": "2024-12-14T08:08:29.151696Z",
"url": "https://files.pythonhosted.org/packages/9e/a8/58e4ae10adc949e7f4cf49545e92d61040592db1b3d61a99b7dc78fe3798/python_esios-0.2.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-14 08:08:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "datons",
"github_project": "python-esios",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "openpyxl",
"specs": []
},
{
"name": "xlrd",
"specs": []
}
],
"lcname": "python-esios"
}
JSON
