Updated README.md and added sample .env file
This commit is contained in:
		
							parent
							
								
									74a9d8cc54
								
							
						
					
					
						commit
						84679fa774
					
				
							
								
								
									
										11
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										11
									
								
								README.md
									
									
									
									
									
								
							| @ -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.  | 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 | # Dependancies | ||||||
| Python 3 and contents of `requirements.txt`  | * Python 3 and contents of `requirements.txt`. | ||||||
| The font `Biko_Regular.otf` | * The font `Biko_Regular.otf`. | ||||||
| A `.png` graphic to write text on. | * 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 | # Bulid Instructions | ||||||
| `pip install -r requirements.txt` | `pip install -r requirements.txt` | ||||||
| 
 | 
 | ||||||
| crontab | user crontab | ||||||
| `05   *     *   *  *    cd ~/.venv/solar_edge && direnv exec . python solar_edge.py > /dev/null 2>&1` | `05   *     *   *  *    cd ~/.venv/solar_edge && direnv exec . python solar_edge.py > /dev/null 2>&1` | ||||||
|  | |||||||
							
								
								
									
										7
									
								
								env.sample
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										7
									
								
								env.sample
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,7 @@ | |||||||
|  | SSH_HOST= | ||||||
|  | SSH_USER= | ||||||
|  | SSH_FOLDER= | ||||||
|  | URL= | ||||||
|  | INFILE= | ||||||
|  | OUTFILE= | ||||||
|  | FONT_FACE= | ||||||
		Loading…
	
		Reference in New Issue
	
	Block a user