Skip to content

Getting Started with Odyssey: Installation Guide

Follow these steps to install Odyssey on your system.

1. Clone the repository

git clone https://gitlab.com/auto_lab/odyssey
cd odyssey

2. Set up the environment

Odyssey uses uv for dependency management and requires Python >= 3.12.3. Install uv (see the uv install docs), then sync dependencies:

uv sync

This creates a .venv and installs the odyssey package (editable) plus its runtime dependencies. To also install the test/lint tooling:

uv sync --all-groups

3. Run the service

uv run uvicorn odyssey.main:app --reload

The interactive API docs (Swagger UI) are then available at http://127.0.0.1:8000/docs.