InNoHassle Monorepo

About

This is the monorepo for some of the backend services of InNoHassle ecosystem, all of them are FastAPI ASGI applications.

• Clubs service - Innopolis University student clubs management system to view clubs, add new clubs, and edit their descriptions and logos.
• Forms - managing Yandex Forms links and generating signed prefilled URLs for authenticated users.
• Guard - gating access to Google Spreadsheets by requiring InNoHassle Accounts authentication before adding users.
• Maps - hosting Innopolis University maps to view them on innohassle.ru.
• Room booking - view and manage room bookings at innohassle.ru via integration with Microsoft Outlook.
• Schedule - aggregate university schedules, personalize favorites, and export ICS calendars at innohassle.ru/schedule.
• Schedule Assistant - build and manage academic schedules, validate placement issues.
• Student Affairs - omnidesk authentication via SSO for Student Affairs department to issue tickets.
• Table Tennis - leaderboard and queue for the Innopolis University table tennis club.
• When2Meet - meeting availability planner for the InNoHassle ecosystem.

Technologies

• Python 3.14 & uv
• FastAPI
• Database and ORM: MongoDB & Beanie; PostgreSQL & SQLAlchemy
• File storage: MinIO
• Formatting and linting: Ruff, prek
• Type checking: ty
• Testing: pytest
• CI/CD: Docker, Docker Compose, GitHub Actions

Contributing

We are open to contributions of any kind. You can help us with code, bugs, design, documentation, media, new ideas, etc. If you are interested in contributing, please read our contribution guide.

Development

Set up for development

1. Install uv and Docker

2. Install dependencies:

   uv sync

3. Install prek hooks:

   uv run prek install --overwrite --prepare-hooks -t pre-commit -t commit-msg

4. Run infra:

   docker compose up --wait mongodb minio

5. Create settings.yaml in monorepo and set up accounts API JWT token:

   uv run scripts/prepare.py

6. Start development server (and read logs in the terminal):

   For VSCode

   In the left menu of the IDE go to "Run and Debug" tab, choose the service name and click play button to start the API. After that, open the URL from console in your browser to view Swagger.

   Set up VSCode plugins

   Go to Extensions and install the following plugins (recommendations in .vscode/extensions.json):

   • Python (by Microsoft)
   • Ruff (by Charlie Marsh)
   • ty (by astral-sh)

   Also, if you will use ty typechecker, you should disable others in VSCode settings:

   {
      "python.languageServer": "None",
      "python.analysis.typeCheckingMode": "off",
   
      "cursorpyright.disableLanguageServices": true,
      "cursorpyright.analysis.typeCheckingMode": "off",
   
      "basedpyright.disableLanguageServices": true,
      "basedpyright.analysis.typeCheckingMode": "off",
   
      "pyright.disableLanguageServices": true,
      "pyright.analysis.typeCheckingMode": "off"
   }

   For PyCharm

   In the top-right corner of the IDE choose the service name and click green play button to start the API ([see docs](https://www.jetbrains.com/help/pycharm/run-debug-configuration.html#createExplicitly)). After that, open the URL from console in your browser to view Swagger.

   Set up PyCharm plugins

   1. Ruff (plugin). It will lint and format your code. Make sure to enable Use ruff format option in plugin settings.
   2. Pydantic (plugin). It will fix PyCharm issues with type-hinting.
   3. Conventional commits (plugin). It will help you to write conventional commits.
   Using console

   For room booking service:

   uv run -m src.room_booking --reload

   It will be available at http://localhost:8008

   For maps service:

   uv run -m src.maps --reload

   It will be available at http://localhost:8009

   For guard service:

   uv run -m src.guard --reload

   It will be available at http://localhost:8013

   For clubs service:

   uv run -m src.clubs --reload

   It will be available at http://localhost:8014

   For student affairs service:

   uv run -m src.student_affairs --reload

   It will be available at http://localhost:8015

   For forms service:

   uv run -m src.forms --reload

   It will be available at http://localhost:8017

   For when2meet service:

   uv run -m src.when2meet --reload

   It will be available at http://localhost:8020

   For table tennis service:

   uv run -m src.tabletennis --reload

   It will be available at http://localhost:8023

   For schedule service:

   uv run -m src.schedule --reload

   It will be available at http://localhost:8024

Important

For endpoints requiring authorization click "Authorize" button in Swagger UI

Tip

Edit settings.yaml according to your needs, you can view schema in settings.schema.yaml

Testing

Testing guidelines, infrastructure details, and common pytest commands are documented in TESTING.md.

Firstly, start the test infrastructure:

docker compose -f docker-compose.test.yaml up --wait

It will setup mongodb and minio services, note that they will be stopped after 1 hour of inactivity.

Then, run the tests:

uv run -m pytest

In output you will see failing tests, timings, coverage, etc.

To rerun only failed tests, you can use:

uv run -m pytest --lf

Git worktrees

To work on several branches in parallel without stashing or switching in the main checkout, see WORKTREE.md.

How to update dependencies

1. Run uv sync --upgrade to update uv.lock file and install the latest versions of the dependencies.
2. Run uv tree --outdated --depth=1 will show what package versions are installed and what are the latest versions.
3. Run uv run prek auto-update to update prek hooks.

Also, Dependabot will help you to keep your dependencies up-to-date, see dependabot.yaml.

How to dump the database

Requires mongodb running (docker compose up --wait mongodb).

1. Dump (f.e. /clubs database):

   docker compose exec mongodb sh -c 'mongodump "mongodb://$MONGO_INITDB_ROOT_USERNAME:$MONGO_INITDB_ROOT_PASSWORD@127.0.0.1:27017/clubs?authSource=admin" --db=clubs --out=dump/'
   docker compose cp mongodb:/dump/clubs ./clubs_dump

2. Restore (f.e. /clubs database):

   docker compose exec mongodb sh -c 'mongorestore "mongodb://$MONGO_INITDB_ROOT_USERNAME:$MONGO_INITDB_ROOT_PASSWORD@127.0.0.1:27017/clubs?authSource=admin" --drop dump/clubs'
   docker compose cp ./clubs_dump mongodb:/dump/clubs

Adding a new service

If you need to scaffold a new service, use the NEW_SERVICE.md guide.