Energy cost calculation
Project description
Energy cost
Python package to model your energy bill based on your energy consumption.
This package is currently under construction, with many features still incomplete or missing. See issues for future planned work and feel free to contribute!
Currently implemented features are documented using notebooks in the notebooks/ directory.
Note on units: all consumption based costs are in €/MWh, all energy values are in MWh. All monetary values are in €.
Development
Prerequisites
- Python 3.12+
- uv (fast Python package manager)
1. Install dependencies
uv sync
uv tool install poethepoet
2. Notebooks
You can easilly test the project using our notebooks. They are located in the notebooks directory and can be run with:
poe notebooks
Some notebooks make use of external APIs and require API keys. You can set these in a .env file in the root of the project, using the .env.example file as a template.
If you add new features, please add a new notebook to demonstrate them.
3. Run tests
poe test
4. Code quality (pre-commit)
Pre-commit hooks are configured out of the box. Install them once:
pre-commit install
Every commit will automatically run:
| Tool | Task | Command |
|---|---|---|
| Ruff | Linting + auto-fix | poe lint |
| Ruff | Formatting | poe format |
| ty | Type checking | poe check |
You can also run them manually at any time.
License
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file energy_cost-0.1.0.tar.gz.
File metadata
- Download URL: energy_cost-0.1.0.tar.gz
- Upload date:
- Size: 9.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1a529aa86017f0cb31dd87ac57b2ba893bfa2bfd912d1675a5441459e85d5ec5
|
|
| MD5 |
3bdfe1288f39e0deaaf58c92fd46dc52
|
|
| BLAKE2b-256 |
9e6e2c6be9af92458a95064fed350de61a2832eb3de26c162cf4cfd93a0c313e
|
File details
Details for the file energy_cost-0.1.0-py3-none-any.whl.
File metadata
- Download URL: energy_cost-0.1.0-py3-none-any.whl
- Upload date:
- Size: 8.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1648c91ff33f54973712d956f56e14a59398f310314879998445913c469f7d0c
|
|
| MD5 |
8dd783c958fc656d50eca6857e31a402
|
|
| BLAKE2b-256 |
a29e7d483e8b8261b37dcd50fe22fe0a11d4de22710a30bc630206da1642daf9
|
