Cli tool for downloading data from ENTSO-E.
Project description
entsopy
Your tool for downloading data from the from *ENTSO-E transparency platform.
Please note that a security token is mandatory for accessing the ENTSO-E API service. Follow the official official instructions to get one.
Features
entsopy cli tool allow you to download data from ENTSO-E transparency platform for the following domains:
- Load
- Generation
- Transmission (WIP)
- Balancing (WIP)
- Outages (WIP)
- Congestion Management (WIP)
- System Operations (WIP)
Requirements
- Python 3.11+ [How to install Python?]
- pip Python package insaller [How to install pip?]
- For performing requests to entso-e API service you need a security token: you can get one by following the official instructions.
Installation
pip install entsopy
Check out the latest entsopy version on pypi: pypi.org/project/entsopy
:warning: If you use Windows make sure to setup properly the following environment variables in your OS:
C:\Users\<username>\AppData\Local\Packages\PythonSoftwareFoundation...\LocalCache\local-packages\Python3...\site-packages
C:\Users\<username>\AppData\Local\Packages\PythonSoftwareFoundation...\LocalCache\local-packages\Python3...\site-packages
Commands
entsopy start
for starting the cli app;entsopy reset
for resetting entsopy configuration data;**entsopy reset security-token
for resetting securiy token;entsopy reset download-dir
for resetting the folder in which data are downloaded;entsopy reset log
for resetting the log file;entsopy reset all
reset complitely the configuration;
entsopy log
for manage entsopy logs;**entsopy --help
for seeing the helper.**
Useful links
- Ensto-e official website: https://www.entsoe.eu/
- Ensto-e transparency platform: https://transparency.entsoe.eu/
- Ensto-e security token: https://transparency.entsoe.eu/content/static_content/Static%20content/web%20api/Guide.html#_authentication_and_authorisation
License
This project is licensed under the terms of the MIT license.
Founding
Entsopy was partially funded by the European Union - NextGenerationEU, in the framework of the GRINS - Growing Resilient, INclusive and Sustainable project (GRINS PE00000018 – CUP C93C22005270001)
Citing
@misc{entsopy_tool,
author = {Lorenzo Perinello, Marina Bertolini},
title = {entsopy - A tool for downloading data from ENTSO-E platform.},
year = {2024},
howpublished = {\url{https://pypi.org/project/entsopy/}},
}
Notes
This tools was developed according official documentations, naming and codes conventions. Find out more here at Transparency Platform Data Repository - user guide.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.