Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Bozydarek committed Jul 14, 2024
1 parent aa3d3e9 commit 54bc7b2
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,30 @@ This repository contains a python scripts that can check your energy usage stati
* Maintaining a cache file (`cache.csv`) to avoid unnecessary API calls (data from this file can be easily loaded to a spreadsheet)
* Generating an ASCII table with monthly data
* Calculating a simple estimation for the current month
* Exporting data to `csv` or `json` format

# How to use?

## Requirements
* python 3.11+
* packages from `requirements.txt`

# Configuration file
## Installation
Clone repository:

```
git clone https://github.com/Bozydarek/tauron_statistics.git
cd tauron_statistics
python3 -m pip -r requirements.txt
```

Create configuration file:
```
cp config.example.yml config.yml
```
... and edit with your favorite editor 😉

## Configuration file

To use this script you need to create a configuration (`config.yml`) based on the example (`config.example.yml`).

Expand All @@ -39,4 +57,5 @@ python3 tauron_statistics.py
python3 tauron_statistics.py -y
python3 tauron_statistics.py -y 2022 --off
python3 tauron_statistics.py -y --no-cache
python3 tauron_statistics.py --offline --format csv
```

0 comments on commit 54bc7b2

Please # to comment.