Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
darcato committed Apr 1, 2023
1 parent ed80a1e commit ad914dc
Showing 1 changed file with 29 additions and 5 deletions.
34 changes: 29 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
# Python library for Italian energy markets
# mercati-energetici

## Example
## Async python library for Italian energy markets

Unofficial wrapper of the GME ([Gestore dei Mercati Energetici S.p.A.](https://mercatoelettrico.org/It/Default.aspx)) APP API. It allows to retrieve prices and volumes traded on the Italian energy markets (electricity, gas and environmental) in a simple and asynchronous way.

### Disclaimer

This library is not affiliated with GME ([Gestore dei Mercati Energetici S.p.A.](https://mercatoelettrico.org/It/Default.aspx)) in any way. It is provided as is, without any warranty. By using this library, you agree to the terms of use of GME API, which can be obtained with ``get_general_conditions()`` or can be found [here](https://www.mercatoelettrico.org/it/tools/AccessoDati.aspx). Please, be aware that all the data belongs to GME and can't be used for profit. Also, be aware of the disclaimer from GME retrivable with ``get_disclaimer()``.

### Example

```python
"""How to get the average price of electricity in Italy (PUN) for a specific date."""
Expand All @@ -11,16 +19,32 @@ from datetime import date

async def main():
async with MGP() as mgp:

# By using this library, you agree to the terms of use of GME API
# which can be obtained with:
print(mgp.get_general_conditions())

# Also, be aware of the following disclaimer from GME
print(mgp.get_disclaimer())

# Get PUN price
print("PUN avg: ", await mgp.daily_pun(date(2023, 3, 28)))


if __name__ == "__main__":
asyncio.run(main())
```

## Disclaimer
## Documentation

The library exposes three low level classes to access the GME API: ``MercatiElettrici``, ``MercatiGas`` and ``MercatiAmbientali``. A further class, ``MGP``, offers a higher level interface over the day-ahead electricity market.

## Usage
### Installation

```bash
pip install mercati-energetici
```

The library exposes three low level classes to access the GME API: ``MercatiElettrici``, ``MercatiGas`` and ``MercatiAmbientali``. A furhter class, ``MGP``, offers a higher level interface over the day-ahead electricity market.
### Usage

See the [documentation](https://mercati-energetici.readthedocs.io/en/latest/) for more details.

0 comments on commit ad914dc

Please sign in to comment.