Asynchronous Python client providing energy/gas prices from EnergyZero


Keywords
energy, energyzero, gas, prices, api, async, client, hacktoberfest, python
License
MIT
Install
pip install energyzero==2.1.0

Documentation

alt Header of the EnergyZero package

GitHub Release Python Versions Project Stage Project Maintenance License

GitHub Activity PyPi Downloads GitHub Last Commit Open in Dev Containers

Code Quality Build Status Typing Status

Maintainability Code Coverage

Asynchronous Python client for the EnergyZero API.

About

A python package with which you can retrieve the dynamic energy/gas prices from EnergyZero and can therefore also be used for third parties who purchase their energy via EnergyZero, such as:

Installation

pip install energyzero

Data

note: Currently only tested for day/tomorrow prices

You can read the following datasets with this package:

Electricity prices

The energy prices are different every hour, after 15:00 (more usually already at 14:00) the prices for the next day are published and it is therefore possible to retrieve these data.

  • Current/Next[x] hour electricity market price (float)
  • Average electricity price (float)
  • Lowest energy price (float)
  • Highest energy price (float)
  • Time of highest price (datetime)
  • Time of lowest price (datetime)
  • Percentage of the current price compared to the maximum price
  • Number of hours with the current price or lower (int)

Gas prices

The gas prices do not change per hour, but are fixed for 24 hours. Which means that from 06:00 in the morning the new rate for that day will be used.

  • Current/Next[x] hour gas market price (float)
  • Average gas price (float)
  • Lowest gas price (float)
  • Highest gas price (float)

Example

import asyncio

from datetime import date
from energyzero import EnergyZero, VatOption


async def main() -> None:
    """Show example on fetching the energy prices from EnergyZero."""
    async with EnergyZero(vat=VatOption.INCLUDE) as client:
        start_date = date(2022, 12, 7)
        end_date = date(2022, 12, 7)

        energy = await client.energy_prices(start_date, end_date)
        gas = await client.gas_prices(start_date, end_date)


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

Class Parameters

Parameter value Type Description
vat enum (default: VatOption.INCLUDE) Include or exclude VAT on class level

Function Parameters

Parameter value Type Description
start_date datetime The start date of the selected period
end_date datetime The end date of the selected period
interval integer (default: 4) The interval of data return (day, week, month, year)
vat enum (default: class value) Include or exclude VAT (VatOption.INCLUDE or VatOption.EXCLUDE)

Interval 4: Dag 5: Maand 6: Jaar 9: Week

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We've set up a separate document for our contribution guidelines.

Thank you for being involved! 😍

Setting up development environment

The simplest way to begin is by utilizing the Dev Container feature of Visual Studio Code or by opening a CodeSpace directly on GitHub. By clicking the button below you immediately start a Dev Container in Visual Studio Code.

Open in Dev Containers

This Python project relies on Poetry as its dependency manager, providing comprehensive management and control over project dependencies.

You need at least:

Install all packages, including all development requirements:

poetry install

Poetry creates by default an virtual environment where it installs all necessary pip packages, to enter or exit the venv run the following commands:

poetry shell
exit

Setup the pre-commit check, you must run this inside the virtual environment:

pre-commit install

Now you're all set to get started!

As this repository uses the pre-commit framework, all changes are linted and tested with each commit. You can run all checks and tests manually, using the following command:

poetry run pre-commit run --all-files

To run just the Python tests:

poetry run pytest

License

MIT License

Copyright (c) 2022-2023 Klaas Schoute

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.