# Python Euskalmet
 
Librería cliente de la API de datos de Euskalmet. Permite obtener y manejar la información de la API de datos abiertos
de Euskadi. Cuenta con una serie de modelos de datos y métodos preparados para poder utilizarlos de forma fácil y
accesible.
La información que recoge y utiliza esta librería es propiedad de la Agencia Vasca de Meteorología.
**ATENCIÓN: Esta librería está en desarrollo y por ello, faltan muchas llamadas a la API de datos de Euskalmet. Abre un
issue o un pull request si quieres que esta librería tenga más funcionalidades. Mi tiempo da para lo que da :)**
## Instalación
Utiliza pip para instalar la librería:
```pip install python-euskalmet```
## Configuración
Es importante crear un directorio de configuración en ``~/.config/python-euskalmet`` para que la librería pueda
guardar la configuración.
### API Key
Obtén tu clave de API en la siguiente [web](https://api.euskadi.eus/met01uiApiKeyUsersWar/index.jsp#/). Luego, hay que soliticar las claves en la [web](https://www.opendata.euskadi.eus/api-euskalmet/-/how-to-use-meteo-rest-services/) y guardarla
en ``~/.config/euskalmet/privateKey.pem``.
### Ficheros de configuración
Por otro lado, hay que definir un fichero de configuración en el directorio ``~/.config/euskalmet/settings.cfg`` con
la siguiente información:
```
[PAYLOAD]
; Issuer (emisor): description issuer description, ex. company name
iss =
; Timestamp expiration: Ex. 1696081478
exp =
; Emission timestamp: (today's epoch)
iat =
; Api key owner email: Ex. name@company.com
email =
```
**Importante**
Destacar, los campos `exp` y `iat` son *timestamps* ([epochs](https://espanol.epochconverter.com/)). El campo
`exp` (fecha de expiración) tiene que ser mayor que `iat` (fecha de emisión del certificado), y dicha emisión la emitirá
el portal de Euskalmet. La fecha de expiración puede ponerse cualquiera, pero siempre más alta que la fecha de hoy.
Del mismo modo, el email tiene que ser el mismo que indicaste en la solicitud de Euskalmet.
## Usar la librería
Si por ejemplo, se quiere descargar las observaciones de una estación,
```
from euskalmet import Stations
estacion = Stations() # Inicializa el objeto
estacion.automatic_download("C017", multiprocess=True) # Descarga la información de la estación
```
Para más información, revisa la documentación.
## ¿Dudas, sugerencias?
Para cualquier duda, sugerencia o mejora, siéntete libre de abrir una issue en el repositorio.
Raw data
{
"_id": null,
"home_page": "https://github.com/r3v1/python-euskalmet",
"name": "python-euskalmet",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "euskalmet weather api euskadi \"basque contry\" opendata",
"author": "David Revillas",
"author_email": "r3v1@pm.me",
"download_url": "https://files.pythonhosted.org/packages/c0/42/1e8b1d1ec7ac810533ad2d1b8c6db3e3dfdeeaaaaad152880d5e1242ffaa/python-euskalmet-0.3.4.tar.gz",
"platform": null,
"description": "# Python Euskalmet\n\n \n\nLibrer\u00eda cliente de la API de datos de Euskalmet. Permite obtener y manejar la informaci\u00f3n de la API de datos abiertos\nde Euskadi. Cuenta con una serie de modelos de datos y m\u00e9todos preparados para poder utilizarlos de forma f\u00e1cil y\naccesible.\n\nLa informaci\u00f3n que recoge y utiliza esta librer\u00eda es propiedad de la Agencia Vasca de Meteorolog\u00eda.\n\n**ATENCI\u00d3N: Esta librer\u00eda est\u00e1 en desarrollo y por ello, faltan muchas llamadas a la API de datos de Euskalmet. Abre un\nissue o un pull request si quieres que esta librer\u00eda tenga m\u00e1s funcionalidades. Mi tiempo da para lo que da :)**\n\n## Instalaci\u00f3n\n\nUtiliza pip para instalar la librer\u00eda:\n\n```pip install python-euskalmet```\n\n## Configuraci\u00f3n\n\nEs importante crear un directorio de configuraci\u00f3n en ``~/.config/python-euskalmet`` para que la librer\u00eda pueda\nguardar la configuraci\u00f3n.\n\n### API Key\n\nObt\u00e9n tu clave de API en la siguiente [web](https://api.euskadi.eus/met01uiApiKeyUsersWar/index.jsp#/). Luego, hay que soliticar las claves en la [web](https://www.opendata.euskadi.eus/api-euskalmet/-/how-to-use-meteo-rest-services/) y guardarla\nen ``~/.config/euskalmet/privateKey.pem``.\n\n### Ficheros de configuraci\u00f3n\n\nPor otro lado, hay que definir un fichero de configuraci\u00f3n en el directorio ``~/.config/euskalmet/settings.cfg`` con\nla siguiente informaci\u00f3n:\n\n```\n[PAYLOAD]\n; Issuer (emisor): description issuer description, ex. company name\niss =\n; Timestamp expiration: Ex. 1696081478\nexp =\n; Emission timestamp: (today's epoch)\niat =\n; Api key owner email: Ex. name@company.com\nemail =\n```\n\n**Importante**\n\nDestacar, los campos `exp` y `iat` son *timestamps* ([epochs](https://espanol.epochconverter.com/)). El campo\n`exp` (fecha de expiraci\u00f3n) tiene que ser mayor que `iat` (fecha de emisi\u00f3n del certificado), y dicha emisi\u00f3n la emitir\u00e1\nel portal de Euskalmet. La fecha de expiraci\u00f3n puede ponerse cualquiera, pero siempre m\u00e1s alta que la fecha de hoy.\n\nDel mismo modo, el email tiene que ser el mismo que indicaste en la solicitud de Euskalmet.\n\n## Usar la librer\u00eda\n\nSi por ejemplo, se quiere descargar las observaciones de una estaci\u00f3n,\n\n```\nfrom euskalmet import Stations\nestacion = Stations() # Inicializa el objeto\nestacion.automatic_download(\"C017\", multiprocess=True) # Descarga la informaci\u00f3n de la estaci\u00f3n\n```\n\nPara m\u00e1s informaci\u00f3n, revisa la documentaci\u00f3n.\n\n## \u00bfDudas, sugerencias?\n\nPara cualquier duda, sugerencia o mejora, si\u00e9ntete libre de abrir una issue en el repositorio.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python API for Euskalmet (https://www.euskalmet.euskadi.eus/hasiera/) open data",
"version": "0.3.4",
"project_urls": {
"Bug Reports": "https://gitlab.com/r3v1/python-euskalmet/issues",
"Homepage": "https://github.com/r3v1/python-euskalmet"
},
"split_keywords": [
"euskalmet",
"weather",
"api",
"euskadi",
"\"basque",
"contry\"",
"opendata"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7179b7584e8ca93e50645839cf3d8cf663139785c2b08eee5f224f9d8bbc74c8",
"md5": "40298681e806ab285869efc8b345bf4d",
"sha256": "bc059f5c999b7a2f0600272f9c96b4e997798d0f46307137643efd3b501da9ca"
},
"downloads": -1,
"filename": "python_euskalmet-0.3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "40298681e806ab285869efc8b345bf4d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 12727,
"upload_time": "2024-01-10T15:37:42",
"upload_time_iso_8601": "2024-01-10T15:37:42.092615Z",
"url": "https://files.pythonhosted.org/packages/71/79/b7584e8ca93e50645839cf3d8cf663139785c2b08eee5f224f9d8bbc74c8/python_euskalmet-0.3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c0421e8b1d1ec7ac810533ad2d1b8c6db3e3dfdeeaaaaad152880d5e1242ffaa",
"md5": "a615b1ca77ab745c0aa93c6a0b92b8a2",
"sha256": "86ce7371d21b592054966457bd78e9ab4288a1898685c9165e1975377560f086"
},
"downloads": -1,
"filename": "python-euskalmet-0.3.4.tar.gz",
"has_sig": false,
"md5_digest": "a615b1ca77ab745c0aa93c6a0b92b8a2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 12287,
"upload_time": "2024-01-10T15:37:43",
"upload_time_iso_8601": "2024-01-10T15:37:43.298765Z",
"url": "https://files.pythonhosted.org/packages/c0/42/1e8b1d1ec7ac810533ad2d1b8c6db3e3dfdeeaaaaad152880d5e1242ffaa/python-euskalmet-0.3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-10 15:37:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "r3v1",
"github_project": "python-euskalmet",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "python-euskalmet"
}
JSON
