{"id":16237163,"url":"https://github.com/klaasnicolaas/python-easyenergy","last_synced_at":"2025-03-15T10:31:08.470Z","repository":{"id":64829842,"uuid":"577738311","full_name":"klaasnicolaas/python-easyenergy","owner":"klaasnicolaas","description":"💰 Asynchronous Python client for the dynamic prices from easyEnergy","archived":false,"fork":false,"pushed_at":"2024-05-09T23:22:31.000Z","size":1492,"stargazers_count":6,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-05-11T22:45:31.872Z","etag":null,"topics":["api","async","client","energy","gas","hacktoberfest","prices","python"],"latest_commit_sha":null,"homepage":"https://www.easyenergy.com/nl/energietarieven","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/klaasnicolaas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"klaasnicolaas","ko_fi":"klaasnicolaas"}},"created_at":"2022-12-13T12:16:14.000Z","updated_at":"2024-05-12T23:33:26.615Z","dependencies_parsed_at":"2022-12-15T19:40:37.890Z","dependency_job_id":"d853da7e-1155-4b42-a5af-46ee94a7362c","html_url":"https://github.com/klaasnicolaas/python-easyenergy","commit_stats":{"total_commits":294,"total_committers":5,"mean_commits":58.8,"dds":"0.36734693877551017","last_synced_commit":"87f47273529ab5b6b07632ba5b73d6c971441d91"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-easyenergy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-easyenergy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-easyenergy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-easyenergy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/klaasnicolaas","download_url":"https://codeload.github.com/klaasnicolaas/python-easyenergy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243718846,"owners_count":20336590,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","async","client","energy","gas","hacktoberfest","prices","python"],"created_at":"2024-10-10T13:34:44.631Z","updated_at":"2025-03-15T10:31:08.455Z","avatar_url":"https://github.com/klaasnicolaas.png","language":"Python","funding_links":["https://github.com/sponsors/klaasnicolaas","https://ko-fi.com/klaasnicolaas"],"categories":[],"sub_categories":[],"readme":"\u003c!-- Header --\u003e\n![alt Header of the easyEnergy package](https://raw.githubusercontent.com/klaasnicolaas/python-easyenergy/main/assets/header_easyenergy-min.png)\n\n\u003c!-- PROJECT SHIELDS --\u003e\n[![GitHub Release][releases-shield]][releases]\n[![Python Versions][python-versions-shield]][pypi]\n![Project Stage][project-stage-shield]\n![Project Maintenance][maintenance-shield]\n[![License][license-shield]](LICENSE)\n\n[![GitHub Activity][commits-shield]][commits-url]\n[![PyPi Downloads][downloads-shield]][downloads-url]\n[![GitHub Last Commit][last-commit-shield]][commits-url]\n[![Open in Dev Containers][devcontainer-shield]][devcontainer]\n\n[![Code Quality][code-quality-shield]][code-quality]\n[![Build Status][build-shield]][build-url]\n[![Typing Status][typing-shield]][typing-url]\n\n[![Maintainability][maintainability-shield]][maintainability-url]\n[![Code Coverage][codecov-shield]][codecov-url]\n\nAsynchronous Python client for the easyEnergy API.\n\n## About\n\nA python package with which you can retrieve the dynamic energy/gas prices from [easyEnergy][easyenergy]. Third parties who purchase their energy via easyEnergy (as far as is known):\n\n- [NieuweStroom](https://nieuwestroom.nl)\n\n## Installation\n\n```bash\npip install easyenergy\n```\n\n## Data\n\n**note**: Currently only tested for day/tomorrow prices\n\nYou can read the following datasets with this package:\n\n### Electricity prices\n\n**note**: easyEnergy has separate prices for usage and return to grid, which also differ per hour.\n\nThe 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.\n\n\n- Current/Next[x] hour electricity market price (float)\n- Lowest energy price (float)\n- Highest energy price (float)\n- Average electricity price (float)\n- Time of highest price (datetime)\n- Time of lowest price (datetime)\n- Percentage of the current price compared to the maximum price\n- Number of hours with the current price or better (int)\n\n### Gas prices\n\nThe 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.\n\n- Current/Next[x] hour gas market price (float)\n- Lowest gas price (float)\n- Highest gas price (float)\n- Average gas price (float)\n\n## Example\n\n```python\nimport asyncio\n\nfrom datetime import date\nfrom easyenergy import EasyEnergy, VatOption\n\n\nasync def main() -\u003e None:\n    \"\"\"Show example on fetching the energy prices from easyEnergy.\"\"\"\n    async with EasyEnergy(vat=VatOption.INCLUDE) as client:\n        start_date = date(2022, 12, 7)\n        end_date = date(2022, 12, 7)\n\n        energy = await client.energy_prices(start_date, end_date)\n        gas = await client.gas_prices(start_date, end_date)\n\n\nif __name__ == \"__main__\":\n    asyncio.run(main())\n```\n\n### Class Parameters\n\n| Parameter | value Type | Description |\n| :-------- | :--------- | :---------- |\n| `vat` | enum (default: **VatOption.INCLUDE**) | Include or exclude VAT on class level |\n\n### Function Parameters\n\n| Parameter | value Type | Description |\n| :-------- | :--------- | :---------- |\n| `start_date` | datetime | The start date of the selected period |\n| `end_date` | datetime | The end date of the selected period |\n| `vat` | enum (default: class value) | Include or exclude VAT (**VatOption.INCLUDE** or **VatOption.EXCLUDE**) |\n\n## Contributing\n\nThis is an active open-source project. We are always open to people who want to\nuse the code or contribute to it.\n\nWe've set up a separate document for our\n[contribution guidelines](CONTRIBUTING.md).\n\nThank you for being involved! :heart_eyes:\n\n## Setting up development environment\n\nThe simplest way to begin is by utilizing the [Dev Container][devcontainer]\nfeature of Visual Studio Code or by opening a CodeSpace directly on GitHub.\nBy clicking the button below you immediately start a Dev Container in Visual Studio Code.\n\n[![Open in Dev Containers][devcontainer-shield]][devcontainer]\n\nThis Python project relies on [Poetry][poetry] as its dependency manager,\nproviding comprehensive management and control over project dependencies.\n\nYou need at least:\n\n- Python 3.11+\n- [Poetry][poetry-install]\n\n### Installation\n\nInstall all packages, including all development requirements:\n\n```bash\npoetry install\n```\n\n_Poetry creates by default an virtual environment where it installs all\nnecessary pip packages_.\n\n### Pre-commit\n\nThis repository uses the [pre-commit][pre-commit] framework, all changes\nare linted and tested with each commit. To setup the pre-commit check, run:\n\n```bash\npoetry run pre-commit install\n```\n\nAnd to run all checks and tests manually, use the following command:\n\n```bash\npoetry run pre-commit run --all-files\n```\n\n### Testing\n\nIt uses [pytest](https://docs.pytest.org/en/stable/) as the test framework. To run the tests:\n\n```bash\npoetry run pytest\n```\n\nTo update the [syrupy](https://github.com/tophat/syrupy) snapshot tests:\n\n```bash\npoetry run pytest --snapshot-update\n```\n\n## License\n\nMIT License\n\nCopyright (c) 2022-2024 Klaas Schoute\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n[easyenergy]: https://www.easyenergy.com\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n[build-shield]: https://github.com/klaasnicolaas/python-easyenergy/actions/workflows/tests.yaml/badge.svg\n[build-url]: https://github.com/klaasnicolaas/python-easyenergy/actions/workflows/tests.yaml\n[code-quality-shield]: https://github.com/klaasnicolaas/python-easyenergy/actions/workflows/codeql.yaml/badge.svg\n[code-quality]: https://github.com/klaasnicolaas/python-easyenergy/actions/workflows/codeql.yaml\n[commits-shield]: https://img.shields.io/github/commit-activity/y/klaasnicolaas/python-easyenergy.svg\n[commits-url]: https://github.com/klaasnicolaas/python-easyenergy/commits/main\n[codecov-shield]: https://codecov.io/gh/klaasnicolaas/python-easyenergy/branch/main/graph/badge.svg?token=RYhiDUamT6\n[codecov-url]: https://codecov.io/gh/klaasnicolaas/python-easyenergy\n[devcontainer-shield]: https://img.shields.io/static/v1?label=Dev%20Containers\u0026message=Open\u0026color=blue\u0026logo=visualstudiocode\n[devcontainer]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/klaasnicolaas/python-easyenergy\n[downloads-shield]: https://img.shields.io/pypi/dm/easyenergy\n[downloads-url]: https://pypistats.org/packages/easyenergy\n[license-shield]: https://img.shields.io/github/license/klaasnicolaas/python-easyenergy.svg\n[last-commit-shield]: https://img.shields.io/github/last-commit/klaasnicolaas/python-easyenergy.svg\n[maintenance-shield]: https://img.shields.io/maintenance/yes/2024.svg\n[maintainability-shield]: https://api.codeclimate.com/v1/badges/8628757a4bde52dbfaf6/maintainability\n[maintainability-url]: https://codeclimate.com/github/klaasnicolaas/python-easyenergy/maintainability\n[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg\n[pypi]: https://pypi.org/project/easyenergy/\n[python-versions-shield]: https://img.shields.io/pypi/pyversions/easyenergy\n[typing-shield]: https://github.com/klaasnicolaas/python-easyenergy/actions/workflows/typing.yaml/badge.svg\n[typing-url]: https://github.com/klaasnicolaas/python-easyenergy/actions/workflows/typing.yaml\n[releases-shield]: https://img.shields.io/github/release/klaasnicolaas/python-easyenergy.svg\n[releases]: https://github.com/klaasnicolaas/python-easyenergy/releases\n\n[poetry-install]: https://python-poetry.org/docs/#installation\n[poetry]: https://python-poetry.org\n[pre-commit]: https://pre-commit.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklaasnicolaas%2Fpython-easyenergy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fklaasnicolaas%2Fpython-easyenergy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklaasnicolaas%2Fpython-easyenergy/lists"}