david-lor / vigobusapi

Updated REST API that provide Stops and Buses information for the public transport system of the city of Vigo (Galicia/Spain) 🚌🚏

Python VigoBusAPI

Intermediate Python + FastAPI API that provide Stop and Bus information provided by the public transport system of the city of Vigo (Galicia/Spain).

The goal of this API is to keep the different data sources and APIs available on one single API with better endpoints structure and more clear data output format (as JSON).

The API can output Stop information and real-time lists of Buses coming to a certain Stop, with their remaining time in minutes.

---

API intermedia basada en Python + FastAPI que provee información de Paradas y Autobuses para el sistema de transporte público de la ciudad de Vigo (Galicia/España).

El objetivo de esta API es unificar las diferentes fuentes de datos y APIs disponibles en una sóla API con mejor estructura de endpoints y una salida de datos con un formato más claro (como JSON).

La API puede devolver información de Paradas y listados en tiempo real de los Autobuses que pasarán por una Parada concreta, con su tiempo restante en minutos.

Features

• API powered by FastAPI, offering a REST API focused web server, fully async and auto-generating documentation.
• Nice-looking, human-readable & easily-parseable endpoint response output as JSON, compared with original data sources.
• Local data storages: Stop cache, Stop MongoDB, Buses cache; to reduce requests to the external API/data sources.
• Original API/data source fixes in Stop names and Buses lines/routes.
• Environment variables / DotEnv file - based settings system.

---

• API basada en FastAPI, que ofrece un servidor web orientado a API REST, asíncrono y que auto-genera documentación.
• Respuestas formateadas como JSON, con mejor estructura, legibles, coherentes y fácilmente procesables, en comparación con los resultados de las fuentes originales.
• Sistemas de almacenamiento local: caché de Paradas, base de datos MongoDB de Paradas, caché de Autobuses; para así reducir las peticiones a las API/fuentes de datos externas.
• Arreglo de nombres de Paradas y líneas/rutas de Autobuses en los datos devueltos por las API/fuentes de datos originales.
• Sistema de configuración basado en variables de entorno / archivo DotEnv.

Requirements

• Python >= 3.6
• Docker recommended - can be deployed using the Docker Python Autoclonable App
• The packages listed on requirements.txt
• A MongoDB server

---

• Python >= 3.6
• Docker recomendado - puede desplegarse con la imagen Docker Python Autoclonable App
• Las dependencias listadas en requirements.txt
• Un servidor MongoDB

Endpoints

• /stop/<stop_id> : Get information about a Stop (name, location), given the Stop ID / Obtener información de una Parada (nombre, ubicación), dado un código de parada
• /buses/<stop_id> / /stop/<stop_id>/buses : Get the Buses that will arrive to a Stop, given the Stop ID / Obtener los Autobuses que pasarán por una Parada, dado su código de parada
• /stops?stop_name=<name>&limit=<limit> : Search stops by name (optional limit) / Buscar paradas por nombre (límite opcional)
• /stops?stop_id=<id2>&stop_id=<id2> : Search multiple stops by id in the same request
• /docs : Swagger UI (documentation) auto-generated by FastAPI / Documentación Swagger UI auto-generada por FastAPI

Changelog

TODO

• Improve Swagger/OpenAPI documentation
• Add static route information endpoints
• Add Near Stops endpoint
• Add endpoint for static maps and StreetView acquisition
• Add endpoints for static buses info
• Add integration tests
• Add detailed install & configuration instructions

---

• Mejorar la documentación de Swagger/OpenAPI
• Añadir endpoint para consulta de rutas estáticas
• Añadir endpoint para consulta de paradas cercanas a ubicación
• Añadir endpoint para obtención de mapas estáticos y StreetView
• Añadir endpoints para consulta de información estática de buses
• Añadir tests de integración
• Añadir instrucciones detalladas de instalación y configuración

Disclaimer

This project is not endorsed by, directly affiliated with, maintained by, sponsored by or in any way officially connected with the company or companies responsible for the public transport service of the city of Vigo.

---

Este proyecto no cuenta con soporte, no está afiliado con, mantenido por, patrocinado por ni en cualquier otra manera oficialmente conectado con la compañía o compañías responsables del sistema de transporte público de la ciudad de Vigo.

vigobusapi's Issues

VigoBus en Homeassistant

Hola, me gustaría saber si existe posibilidad de que la app pueda ser integrada en Homeassistant mediante HACS. Esto con el fin de poder visualizar en el lovelace de HA las tarjetas en tiempo real de determinadas paradas de buses. Gracias de antemano.