README.md

ADDLidar API

Specifications

This API provides a RESTful interface for processing LiDAR point cloud data. Built with FastAPI and Docker, it offers various data manipulation capabilities.

Tech Stack

• Python 3.9
• FastAPI
• Docker
• Kubernetes (for deployment)
• UV package manager

Requirements

• Docker installed
• Python 3.9+
• Make (optional, for using Makefile commands)

Development Setup

1. Clone the repository
2. Install dependencies: make install or uv pip install -r requirements.txt
3. Run locally: make run or uvicorn src.main:app --reload

API Endpoints

• GET /process-point-cloud: Process point cloud data with customizable parameters

Docker Usage

docker build -t lidar-api .
docker run -p 8000:8000 lidar-api

Testing

Run tests with: make test or pytest

Code Quality

• Linting: make lint
• Formatting: make format

Todo when setting up your github repo

• Learn how to use github template repository: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template
• Activate discussion (https://github.com/EPFL-ENAC/AddLidar-API/settings)
• Replace AddLidar-API by the name of your repo
• Modifiy or remove the CITATION.cff file. How to format it ?
• Check if you need all those labels: https://github.com/EPFL-ENAC/AddLidar-API/labels
• Create your first milestone: https://github.com/EPFL-ENAC/AddLidar-API/milestones
• Protect your branch if you're a pro user: https://github.com/EPFL-ENAC/AddLidar-API/settings/branches