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

This is the API for music room service in InNoHassle ecosystem.

• 🎵 Booking Music room
• 📅 Schedule of Music room
• 🔒 Roles and permissions

• Python 3.12 & Poetry
• FastAPI & Pydantic
• Aiogram 3 & aiogram-dialog
• Database and ORM: PostgreSQL, SQLAlchemy, Alembic
• Formatting and linting: Ruff, pre-commit
• Deployment: Docker, Docker Compose, GitHub Actions

1. Install Python 3.12+ & Poetry
2. Install project dependencies with Poetry.

   poetry install

3. Start the API:

   poetry run python -m src.api

   Follow provided instructions if needed

4. Start the Bot:

   poetry run python -m src.bot

   Follow provided instructions if needed

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.

Aiogram:

All localized bot messages should be wrapped: __("Hello world"")

1. Extract messages:

   poetry run pybabel extract -k __ --input-dirs=. -o locales/messages.pot

2. Update translations:

   poetry run pybabel update -i locales/messages.pot -d locales -D messages --ignore-pot-creation-date

3. Translate messages in created .po files
4. Compile translations:

   poetry run pybabel compile -d locales -D messages

Aiogram dialog:

Add translations identifiers (strings inside I18Format) and their translations to .ftl files

We use Docker with Docker Compose plugin to run the website on servers.

1. Copy the file with environment variables: cp .env.example .env
2. Change environment variables in the .env file
3. Copy the file with settings: cp settings.example.yaml settings.yaml
4. Change settings in the settings.yaml file according to your needs (check settings.schema.yaml for more info)
5. Install Docker with Docker Compose
6. Build a Docker image: docker compose build --pull
7. Run the container: docker compose up --detach
8. Check the logs: docker compose logs -f

1. Run poetry update to update all dependencies (it may update nothing, so double-check)
2. Run poetry show --outdated --all to check for outdated dependencies
3. Run poetry add <package>@latest to add a new dependency if needed

1. Run poetry run pre-commit autoupdate

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

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.