Backend API of RoboGlance

RoboGlance is a smartwatch app with complications that help you stay informed about your FTC/FRC events.

The backend processes live match data to keep the client smartwatch app up-to-date.

These instructions are for developing the RoboGlance API in VS Code.

1. install prerequisites
   • VS Code
   • uv
2. clone the git repository
3. open the git repository in VS Code
4. configure Git to rebase by default when pulling in this repository

   git config pull.rebase true

5. install workspace recommended VS Code extensions
6. setup virtual environment with uv

   uv sync

7. copy this .env file in your repository root and add your api keys

   ROBOGLANCE_TBA_API_KEY=<your read API key> # get from https://www.thebluealliance.com/account

8. run the development server
   • using the "Python Debugger: RoboGlance API" launch configuration in VS Code
   • using the terminal

     uv run fastapi dev

9. open http://localhost:8000/docs to test endpoints
10. run automated tests
    • using the "Testing" sidebar in VS Code
    • using the terminal

      uv run pytest -v tests

11. run type checking
    • using the ty VS Code extension
    • using the terminal

      uv run ty check

12. format code with Ruff
    • by enabling "Format on Save" in your settings or using the "Format Document" command in VS Code
    • using the terminal

      uv run ruff format

13. lint code with Ruff
    • using the Ruff VS Code extension
    • using the terminal

      uv run ruff check