Metadata-Version: 2.1
Name: energy_tariff_scheduler
Version: 0.0.2
Summary: Schedule actions based on energy tariffs
Author: Craig White
Author-email: dev.craigw@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pydantic==2.10.4
Requires-Dist: requests==2.32.3
Requires-Dist: python-dateutil==2.9.0.post0
Requires-Dist: apscheduler==3.11.0

# Energy Tariff Scheduler

Enables smart actions based on daily pricing from utilities.

```sh
pip install energy-tariff-scheduler
```

Full documentation: [https://craigwh10.github.io/energy-tariff-scheduler/](https://craigwh10.github.io/energy-tariff-scheduler/)

## Supported tariff's (so far)

- [Octopus Agile](https://octopus.energy/smart/agile/)

## Structure

- [prices.py](./prices.py): responsible for fetching data from external APIs and transform for usage based on contracts
- [schedules.py](./schedules.py): responsible for creating schedules and applying pricing logic
- [runner.py](./runner.py): responsible for the interface between users and the program
- [config.py](./config.py): responsible for providing validated user inputted configuration

## FAQ

> Do I need my account number?

No, this is using public APIs to fetch the pricing data.

> Why are no actions running between 11pm and 12am for Octopus Agile?

This is due to data availability, Octopus only provide pricing data from 12am-11:00pm.
