Merge pull request #30 from jmrr/docs

Documenta el caso de uso de la predicción de temperaturas por municipio

Author: pablo-moreno

aemet/__init__.py

@@ -1,14 +1,23 @@
 from aemet.models import *  # noqa
 import click
 
+
 @click.command()
-@click.option('-p', '--prediccion', help='Muestra la predicción meteorológica dado un nombre de municipio')
-def main(prediccion):
-    client = Aemet()
-    municipio = Municipio.buscar(prediccion)
-    p = client.get_prediccion(municipio.get_codigo())
-    for dia in p.prediccion:
-        print(dia.fecha)
-        print('Máxima: {}'.format(dia.temperatura['maxima']))
-        print('Mínima: {}'.format(dia.temperatura['minima']))
-        print()
+@click.option(
+    "-p",
+    "--prediccion",
+    help="Muestra la predicción meteorológica dado un nombre de municipio",
+)
+@click.option("-k", "--key", help="API key AEMET")
+@click.option("-f", "--keyfile", help="Fichero con la clave de la AEMET.")
+def main(prediccion, key, keyfile):
+    client = Aemet(api_key=key, api_key_file=keyfile)
+    # ToDo: eliminar el for loop de los municipios si se implementa #29
+    municipios = Municipio.buscar(prediccion)
+    for municipio in municipios:
+        print(f"Predicción de temperaturas para {municipio.nombre}:\n")
+        p = client.get_prediccion(municipio.get_codigo())
+        for dia in p.prediccion:
+            print(dia.fecha)
+            print("Máxima: {}".format(dia.temperatura["maxima"]))
+            print("Mínima: {}\n".format(dia.temperatura["minima"]))

docs/README.md

@@ -0,0 +1,66 @@
+# Casos de uso de `python-aemet`
+
+## Requisitos previos
+
+### Instalar la librería `python-aemet`
+
+- Tener `python3` instalado en el sistema: `which python`
+
+- Instalar la librería en el local. Recomendamos el uso de un `virtualenv` o un gestor
+de entornos como `pyenv`.
+
+  Instala la librería
+
+  ```bash
+  pip install python-aemet
+  ```
+
+### Obtener la clave API
+
+Obtén tu clave de API en la siguiente URL:
+
+<https://opendata.aemet.es/centrodedescargas/obtencionAPIKey>
+
+Y ponla en un fichero `aemet.key`
+
+## Casos de uso
+
+### Predicción de la temperatura máxima y mínima en un municipio concreto en los próximos días
+
+```bash
+aemet -p Huelva -f /path/a/la/clave/aemet.key
+```
+
+La salida:
+
+```sh
+Predicción de temperaturas para Huelva:
+
+2021-04-04T00:00:00
+Máxima: 23
+Mínima: 12
+
+2021-04-05T00:00:00
+Máxima: 22
+Mínima: 13
+
+2021-04-06T00:00:00
+Máxima: 25
+Mínima: 11
+
+2021-04-07T00:00:00
+Máxima: 25
+Mínima: 13
+
+2021-04-08T00:00:00
+Máxima: 23
+Mínima: 12
+
+2021-04-09T00:00:00
+Máxima: 21
+Mínima: 12
+
+2021-04-10T00:00:00
+Máxima: 21
+Mínima: 13
+```