https://api.innohassle.ru/workshops/v0

Did you know that GitHub supports table of contents by default 🤔

This is the API for workshops service in InNoHassle ecosystem. It provides backend functionality for managing workshops, user check-ins, and capacity management.

• ✅ Check-in/check-out workshops for bootcamp participants
• 👨‍💼 Manage workshops for admins
• 📊 Capacity management and tracking

• Python 3.13+ & uv
• FastAPI
• Database and ORM: PostgreSQL, SQLModel, SQLAlchemy, Alembic

1. Install uv and Docker
2. Install dependencies:

   uv sync

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

   uv run -m src.api --reload

4. Open in the browser: http://localhost:8005

   The api will be reloaded when you edit the code

Set up PyCharm integrations

1. Run configurations (docs). Right-click the __main__.py file in the project explorer, select Run '__main__' from the context menu.
2. Ruff (plugin). It will lint and format your code. Make sure to enable Use ruff format option in plugin settings.
3. Pydantic (plugin). It will fix PyCharm issues with type-hinting.
4. Conventional commits (plugin). It will help you to write conventional commits.

1. Create test-db database in your local PostgreSQL:

   docker exec -it workshops-db-1 psql -U postgres -c 'CREATE DATABASE "test-db";'

2. Run tests with SETTINGS_PATH=settings.test.yaml uv run pytest

1. Run docker compose up -d db to start the PostgreSQL container (create .env file with options if needed)
2. Run uv run alembic upgrade head to apply all pending migrations
3. Run uv run alembic revision --autogenerate -m "description" to create new migration
4. Run uv run alembic current to check current migration status
5. Revert all migrations: uv run alembic downgrade base
6. Just set to base to revert to the initial state: uv run alembic stamp base

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.