umbara

Umbara Project

Prerequisites

You will need:

• python^3.11 (see pyproject.toml for full version)

Development

When developing locally, we use:

• editorconfig plugin (required)
• poetry (required)
• pycharm 2017+ or vscode

Quick start

Сheck your python version (should be 3.11)

1. Install poetry

pip install poetry

2. Choose poetry python version 3.11

poetry env use /full/path/to/python

3. Download all dependencies to mod dev

poetry install

If you only need dependencies for production, then

poetry install --only main

4. Before starting the project, you need to create an .env file in the directory config and fill it with the .env.template file in the same directory

5. Updating tables in a database

poetry run python manage.py migrate

6. Collect all statics in staticfiles

poetry run python manage.py collectstatic --noinput

7. Compile localization files

poetry run python manage.py compilemessages

8. Start django server

poetry run python manage.py runserver

Optional

Create user for django admin
Attention: This should be done after migrations

poetry run python manage.py createsuperuser

Running tests and coverage

poetry run pytest

Running Type Checker

poetry run mypy manage.py server
poetry run mypy tests

Running linter flake8

poetry run flake8 .

Compiling localization

poetry run python manage.py compilemessages