vjaguilera/chilean-carplate-api

title	description	tags
Chilean Plates FastAPI	A FastAPI server to retrieve chilean car plates data	fastapi python chile cars

Chilean Plates FastAPI in Railway

This example starts up a FastAPI server.

💁‍♀️ How to deploy

• Deploy using the button 👆
• Clone locally and install packages with Pip using pip install -r requirements.txt or Poetry using poetry install
• Connect to your project using railway link
• Run locally using uvicorn main:app --reload

📝 DEtails

• Utilizando una query cURL muy especifica, se puede obtener los datos de las patentes chilenas.

Running Local

Para correr el programa se debe:

1. Instalar Python >3.8
2. Crear un ambiente virtual con python -m venv venv
3. Activar el ambiente virtual con el comando source venv/bin/activate
4. Instalar paquetes con el comando pip install -r requirements.txt
5. Correr el comando python main.py

Consideraciones:

• Se creará un archivo response.html con el codigo HTML del sitio web scrapeado

Para correr el proyecto como API

1. Asegurar instalacion de paquetes fastapi y uvicorn[standard]
2. Abrir terminal y correr el comando uvicorn main:app --reload
3. Abrir el puerto que aparece

Para correrlo con Docker

1. Crear la imagen localmente docker build . -t chilean-carplates-api
2. Correr la imagen como contenedor: docker run --p 8000:80 chilean-carplates-api

Recommended

• Abrir el siguiente url para ver documentacion: http://127.0.0.1:8000/docs, el path docs lleva directamente a una documentacion en OpenAPI