karkas/docs/DEV.md

Настройка рабочего окружения

Данная инструкция поможет вам настроить рабочее окружение для разработки Karkas.

Предварительные требования

• Python — платформа «Каркас» требует интерпретатор языка Python версии 3.12;
• VSCode — рекомендованная среда разработки;
• Git — инструмент контроля версий, необходим клонирования репозиториянео.

Шаги

1. Клонируйте репозиторий с помощью утилиты git:

git clone https://gitflic.ru/project/alt-gnome/karkas.git

2. Откройте папку karkas в VSCode. Среда разработки автоматически предложит открыть проект как Workspace, используя файл karkas.code-workspace. Нажмите Открыть Workspace, чтобы принять предложение;

3. Установите инструмент Poetry, следуя инструкциям из официальной документации.

4. Выполните команду poetry install в корне проекта.

5. Выполните команду soruce ./.venv/bin/activate в корне проекта.

6. Выполните команду pre-commit install -t commit-msg -t pre-commit в корне проекта.

7. Для каждого пакета выполните следующую последовательность действий:

   • Перейдите в папку пакета (например, src/karkas_core);
   • Выполните команду poetry install, чтобы установить зависимости пакета.

8. Выполните команду soruce ./.venv/bin/activate в папке пакета, над которым будут производится работы, чтобы активировать виртуальное окружение.

Теперь рабочее окружение настроено!

Дополнительная информация

• Каждый пакет в монорепозитории имеет свой собственный файл pyproject.toml, где указаны его зависимости;
• Poetry автоматически управляет виртуальными окружениями для каждого пакета;
• Вы можете использовать команду poetry add <package_name> (где <package_name> — имя пакета) для добавления новых зависимостей.