Asynchronous Python client providing energy prices from spot-hinta.fi
Project description
Spot-Hinta.fi Python client
Asynchronous Python client for the spot-hinta.fi API.
About
A Python package with which you can retrieve the energy market prices from spot-hinta.fi.
Based on the easyEnergy library by @klaasnicolaas.
Installation
pip install spothinta-api
Data
This client currently supports getting today's and tomorrow's hourly energy prices. The prices for tomorrow are usually published between 14:00 and 15:00. See spot-hinta.fi API documentation for more information about the available data.
Example
import asyncio
from datetime import date
from spothinta import SpotHinta
async def main() -> None:
"""Show example on fetching the energy prices from spot-hinta.fi."""
async with SpotHinta() as client:
energy = await client.energy_prices()
if __name__ == "__main__":
asyncio.run(main())
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
This Python project is fully managed using the Poetry dependency manager.
You need at least:
- Python 3.10+
- 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
License
MIT License
Copyright (c) 2022-2023 Sebastian Lövdahl, 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.
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.
Source Distribution
Built Distribution
Hashes for spothinta_api-0.6.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ad58ceed91e8447cf39d22eff6c5c2b1ddd9a32515eb4a2b8e9d9919b86607b |
|
MD5 | 7a594ca43ced265d01e394c5443d9648 |
|
BLAKE2b-256 | 60845ccd799e2e75bbfd89ff3b4d9d3b61ca70251a4cabda26ac842eae6008a3 |