Updated README.md and added sample .env file

This commit is contained in:
Fred Warren 2019-04-15 15:47:27 -07:00
parent 74a9d8cc54
commit 84679fa774
2 changed files with 14 additions and 4 deletions

View File

@ -2,13 +2,16 @@
When placed in a cron job this uppdater will make an https call to a json api to retrieve the co2 savings and equivenant trees planted and overlay those numbers on a graphic and upload them to the website.
# Dependancies
Python 3 and contents of `requirements.txt`
The font `Biko_Regular.otf`
A `.png` graphic to write text on.
* Python 3 and contents of `requirements.txt`.
* The font `Biko_Regular.otf`.
* A `.png` graphic to write text on.
* The package direnv and the follwing changes to the user account:
* [bash.rc] (https://github.com/direnv/direnv/wiki/Python#bash)
* [venv] (https://github.com/direnv/direnv/wiki/Python#venv-stdlib-module)
# Bulid Instructions
`pip install -r requirements.txt`
crontab
user crontab
`05 * * * * cd ~/.venv/solar_edge && direnv exec . python solar_edge.py > /dev/null 2>&1`

7
env.sample Normal file
View File

@ -0,0 +1,7 @@
SSH_HOST=
SSH_USER=
SSH_FOLDER=
URL=
INFILE=
OUTFILE=
FONT_FACE=