nednl 0.1.0

Gain insight into current and predictive energy data from The Netherlands

Asynchronous Python client for National Energy Dashboard NL.

About

A Python package that allows you to retrieve data via the API of the National Energy Dashboard. A data portal with datasets about the gas and electricity providing / consuming in the Netherlands.

Installation

pip install nednl

API Key

Before accessing the datasets, it's necessary to create an account on the website of NED. After you have done this, you'll be able to generate a unique API key, granting you access to the datasets.

Datasets

• All activities
• All classifications
• All granularities
• All granularity timezones
• All points
• All types
• Utilization

Currently there is a limit of 200 requests per 5 minutes.

Example

An example of how you can query the solar consumption of the Netherlands with a granularity per 10 minutes.

import asyncio

from nednl import NedNL


async def main() -> None:
    """Show example on using this package."""

    async with NedNL("YOUR_API_KEY") as client:
        response = await client.utilization(
            point_id=0,
            type_id=2,
            granularity_id=3,
            granularity_timezone_id=1,
            classification_id=2,
            activity_id=1,
            start_date="2024-03-29",
            end_date="2024-03-30",
        )
        print(response)

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

More examples can be found in the examples folder.

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! :heart_eyes:

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.

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

You need at least:

• Python 3.11+
• Poetry

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

To update the syrupy snapshot tests:

poetry run pytest --snapshot-update

License

MIT License

Copyright (c) 2024 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.