Skip to content

Quick Start

Get Lanterne Rouge up and running in minutes with this streamlined setup guide.

Prerequisites

  • Python 3.8 or higher
  • Git
  • API access to:
  • Oura Ring (personal access token)
  • Strava (API credentials)
  • OpenAI (API key)

Installation

# Clone the repository
git clone https://github.com/alponsirenas/lanterne-rouge.git
cd lanterne-rouge

# Create virtual environment
python3 -m venv .venv
source .venv/bin/activate

# Install dependencies
pip install -r requirements.txt

# Clone the repository
git clone https://github.com/alponsirenas/lanterne-rouge.git
cd lanterne-rouge

# Create virtual environment
python -m venv .venv
.venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

Basic Configuration

  1. Create environment file: 

    cp .env.example .env

  2. Add your API credentials to .env: 

    OURA_TOKEN=your_oura_personal_access_token
STRAVA_CLIENT_ID=your_strava_client_id
STRAVA_CLIENT_SECRET=your_strava_client_secret
STRAVA_REFRESH_TOKEN=your_strava_refresh_token
OPENAI_API_KEY=your_openai_api_key

First Run

  1. Initialize the database: 

    python -c "from lanterne_rouge.mission_config import bootstrap; bootstrap('missions/tdf_sim_2025.toml')"

  2. Run your first coaching session: 

    python scripts/daily_run.py

  3. Optional: Set up Fiction Mode: 

    python scripts/configure_rider_profile.py example
python scripts/run_fiction_mode.py --preview

What's Next?

Daily Automation

Once you're comfortable with manual runs, consider setting up GitHub Actions for automated daily coaching reports.

Need Help?

Check our troubleshooting guide or open an issue on GitHub.