Maps

Table of contents

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

About

This is the API for viewing maps in InNoHassle.

Technologies

• Python 3.12 & Poetry
• FastAPI & Pydantic
• Formatting and linting: Ruff, pre-commit
• Deployment: Docker, Docker Compose, GitHub Actions

Development

Set up for development

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

   poetry install

3. Start development server:

   poetry run python -m src.api --reload

   Follow provided instructions if needed

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

   The api will be reloaded when you edit the code

Important

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

Tip

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

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.

Deployment

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

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

How to update dependencies

Project dependencies

1. Run poetry update to update all dependencies
2. Run poetry show --outdated to check for outdated dependencies
3. Run poetry add <package>@latest to add a new dependency if needed

Pre-commit hooks

1. Run poetry run pre-commit autoupdate