From 72c7dfbe63f210d31ce341c918686f0062a48279 Mon Sep 17 00:00:00 2001 From: djib Date: Sat, 19 Oct 2019 17:17:02 +0200 Subject: [PATCH] Improve documentation --- Pipfile.lock | 12 ++++++------ README.md | 8 ++++++-- weather_to_freemobile.py | 1 - 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/Pipfile.lock b/Pipfile.lock index 0de5f57..541845e 100644 --- a/Pipfile.lock +++ b/Pipfile.lock @@ -18,10 +18,10 @@ "default": { "certifi": { "hashes": [ - "sha256:046832c04d4e752f37383b628bc601a7ea7211496b4638f6514d0e5b9acc4939", - "sha256:945e3ba63a0b9f577b1395204e13c3a231f9bc0223888be653286534e5873695" + "sha256:e4f3620cfea4f83eedc95b24abd9cd56f3c4b146dd0177e83a21b4eb49e21e50", + "sha256:fd7c7c74727ddcf00e9acd26bba8da604ffec95bf1c2144e67aff7a8b50e6cef" ], - "version": "==2019.6.16" + "version": "==2019.9.11" }, "chardet": { "hashes": [ @@ -65,10 +65,10 @@ }, "urllib3": { "hashes": [ - "sha256:b246607a25ac80bedac05c6f282e3cdaf3afb65420fd024ac94435cabe6e18d1", - "sha256:dbe59173209418ae49d485b87d1681aefa36252ee85884c31346debd19463232" + "sha256:3de946ffbed6e6746608990594d08faac602528ac7015ac28d33cee6a45b7398", + "sha256:9a107b99a5393caf59c7aa3c1249c16e6879447533d0887f4336dde834c7be86" ], - "version": "==1.25.3" + "version": "==1.25.6" } }, "develop": {} diff --git a/README.md b/README.md index 8cd4452..c68ceac 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,9 @@ A simple script that sends [OpenWeatherMap](https://openweathermap.org/) forecas To run the script you need to fill in `config.sample.json` and to rename it to `config.json`. -See `Pipfile` for the script's requirements. +You will need a [API key from OWM](https://home.openweathermap.org/api_keys), and [one from FreeMobile](https://www.freenews.fr/freenews-edition-nationale-299/free-mobile-170/nouvelle-option-notifications-par-sms-chez-free-mobile-14817). + +See `Pipfile` for the script's requirements (you probably only need to install `pyowm`). Sample output: ``` @@ -23,7 +25,9 @@ Un simple script pour envoyer les prévisions météo [OpenWeatherMap](https://o Pour lancer le script, vous avez besoin d'ajuster les éléments du fichier `config.sample.json` et le renommer en `config.json`. -Vous devrez installer les librairies décrites dans `Pipfile`. +Vous aurez besoin d'une [clef API OpenWeatherMap](https://home.openweathermap.org/api_keys), et une [clef API SMS FreeMobile](https://www.freenews.fr/freenews-edition-nationale-299/free-mobile-170/nouvelle-option-notifications-par-sms-chez-free-mobile-14817). + +Vous devrez installer les librairies décrites dans `Pipfile` (a priori uniquement `pyowm`). Exemple de SMS: ``` diff --git a/weather_to_freemobile.py b/weather_to_freemobile.py index 8bf30ec..f27b60d 100755 --- a/weather_to_freemobile.py +++ b/weather_to_freemobile.py @@ -126,4 +126,3 @@ if __name__ == "__main__": ) wtf = WeatherToFreemobile(config_file) wtf.send_sms_to_freemobile(wtf.get_weather()) - print(wtf.get_weather())