https://github.com/jpsingleton/octoplot
Command line tool that draws a graph of the Octopus Energy Agile pricing in your terminal 🐙 💷 📉
https://github.com/jpsingleton/octoplot
dotnet dotnet-core dotnetcore energy graph octopus-energy-agile
Last synced: about 1 month ago
JSON representation
Command line tool that draws a graph of the Octopus Energy Agile pricing in your terminal 🐙 💷 📉
- Host: GitHub
- URL: https://github.com/jpsingleton/octoplot
- Owner: jpsingleton
- License: eupl-1.2
- Created: 2020-06-01T09:19:32.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-01-22T15:13:14.000Z (over 5 years ago)
- Last Synced: 2024-05-01T21:41:37.991Z (about 2 years ago)
- Topics: dotnet, dotnet-core, dotnetcore, energy, graph, octopus-energy-agile
- Language: C#
- Homepage: https://unop.uk/octoplot-visualise-paid-energy-use-in-your-terminal/
- Size: 88.9 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# OctoPlot
OctoPlot is a small command line tool that draws a graph of the [Octopus Energy Agile](https://octopus.energy/agile/) pricing in your terminal.
Agile Octopus is a 100% green electricity tariff that regularly _pays you_ to consume electricity.
Welcome to the future.
If you are not already living in the future then you can switch to Octopus Energy and get [£50 credit with this referral link](https://share.octopus.energy/witty-wave-889).
## Examples
Down [to 11](https://youtu.be/4xgx4k83zzc?t=39s).
Down to 12.
Getting pricing data...
Pricing data from Fri 22 May 13:00 to Sun 24 May 15:00 for region P
18p
17p £ £
16p £££
15p £ £££
14p £££££
13p £££££ £ £££
12p £££££ £ £££
11p ££££££ £££££
10p ££££££ £££££
09p ££££££ £££££
08p ££££££ £££££
07p ££££££ £££££
06p £££££££ ££££££
05p £££££££ £ £ £ ££££££
04p £££££££££££££ ££££££ £
03p £££££££££££££ ££££££ £ £
02p £££££££££££££ £ ££££££ £ £ £
01p ££££££££££££££££ £££££££££££££££££££ ££
00p £ ££££££££££££££££££ ££££ £££££££££££££££££££ ££ £
---------------------------------------------------------------------------------------------------------
-01p £ £££££££££££££££££££ ££££ ££££££££££££££££££££ £££££££
-02p £££ ££££££££££££££££££££ £££££ £ £££££££££££££££££££££ £ £ ££££££££ £
-03p ££££ ££££££££££££££££££££££ £££££££££ £££££££££££££££££££££ £ £ £££££££££££
-04p £££££££££££££££££££££££££££ ££££££££££££ £££££££££££££££££££££££ £ £ £ £££££££££££
-05p £££££££££££££££££££££££££££ £ ££££££££££££ ££££££££££££££££££££££££££ £ £ £££££££££££££
-06p £££££££££££££££££££££££££££££ £ £££££££££££££ ££££££££££££££££££££££££££££££££££££££££££££££
-07p £££££££££££££££££££££££££££££ ££ £££££££££££££ ££££££££££££££££££££££££££££££££££££££££££££££
-08p ££££££££££££££££££££££££££££££ ££ £££££££££££££ ££££££££££££££££££££££££££££££££££££££££££££££
-09p ££££££££££££££££££££££££££££££ ££ £££££££££££££ ££££££££££££££££££££££££££££££££££££££££££££££
-10p ££££££££££££££££££££££££££££££££ £££ £££££££££££££ ££££££££££££££££££££££££££££££££££££££££££££££
-11p ££££££££££££££££££££££££££££££££££££ £££££££££££££ ££££££££££££££££££££££££££££££££££££££££££££££
1 1 1 1 1 1 1 2 2 2 2 1 1 1 1 1 1 1 1 1 1 2 2 2 2 1 1 1 1 1
3 4 5 6 7 8 9 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4
Paid most for electricity between Sat 23 May 14:30 and Sat 23 May 15:00 (-12.327p/kWh inc. VAT)
## Use
Download a pre-built self-contained binary from the [releases page](https://github.com/jpsingleton/octoplot/releases) and decompress it to a folder.
Change directory to the folder in a command prompt.
Run the app in your terminal specifying the [region ID character](https://en.wikipedia.org/wiki/Distribution_network_operator#History) for the area you are interested in.
E.g. `./octoplot j` for South East England.
The default value is `P` (North Scotland).
Add the folder to your `PATH` if you want to run `octoplot` from anywhere.
### Regions
These are the [region codes](api/Region.cs):
```c#
EastEngland = "A"
EastMidlands = "B"
London = "C"
NorthWales = "D"
WestMidlands = "E"
NorthEastEngland = "F"
NorthWestEngland = "G"
SouthEngland = "H"
SouthEastEngland = "J"
SouthWales = "K"
SouthWestEngland = "L"
Yorkshire = "M"
SouthScotland = "N"
NorthScotland = "P"
```
## Build
To build and run from source you will need the [.NET SDK](https://dotnet.microsoft.com/).
Clone the repo.
```bash
git clone git@github.com:jpsingleton/octoplot.git
```
Run the tool for the region you are in.
```bash
dotnet run j
```
## License
Licensed under the [EUPL-1.2-or-later](https://joinup.ec.europa.eu/collection/eupl/introduction-eupl-licence)
This project is _treeware_! If you found it useful then please [plant a tree for me](https://offset.earth/unitsetsoftware).
[](https://offset.earth/unitsetsoftware)