karkas/docs/DEV.md

35 lines
2.5 KiB
Markdown
Raw Normal View History

# Настройка рабочего окружения
2024-08-02 16:59:51 +03:00
Данная инструкция поможет вам настроить рабочее окружение для разработки Karkas.
2024-08-02 16:59:51 +03:00
## Предварительные требования
2024-08-02 16:59:51 +03:00
- **Python** — платформа «Каркас» требует интерпретатор языка Python версии 3.12;
- **VSCode** — рекомендованная среда разработки;
- **Git** — инструмент контроля версий, необходим клонирования репозиториянео.
2024-08-02 16:59:51 +03:00
## Шаги
2024-08-02 16:59:51 +03:00
1. Клонируйте репозиторий с помощью утилиты `git`:
2024-08-02 16:59:51 +03:00
```shell
git clone https://gitflic.ru/project/alt-gnome/karkas.git
```
2024-08-02 16:59:51 +03:00
2. Откройте папку `karkas` в VSCode. Среда разработки автоматически предложит открыть проект как Workspace, используя файл `karkas.code-workspace`. Нажмите `Открыть Workspace`, чтобы принять предложение;
2024-08-02 16:59:51 +03:00
3. Установите инструмент Poetry, следуя инструкциям из [официальной документации](https://python-poetry.org/docs/). Для каждого пакета выполните следующую последовательность действий:
2024-08-02 16:59:51 +03:00
- Перейдите в папку пакета (например, `src/karkas_core`);
- Выполните команду `poetry install`, чтобы установить зависимости пакета. После этого будет создано виртуальное окружене (`.venv`);
2024-08-02 16:59:51 +03:00
4. Выполните команду `poetry shell` в папке пакета, над которым будут производится работы, чтобы активировать виртуальное окружение.
2024-08-02 16:59:51 +03:00
Теперь рабочее окружение настроено!
## Дополнительная информация
- Каждый пакет в монорепозитории имеет свой собственный файл `pyproject.toml`, где указаны его зависимости;
- Poetry автоматически управляет виртуальными окружениями для каждого пакета;
- Вы можете использовать команду `poetry add <package_name>` (где `<package_name>` — имя пакета) для добавления новых зависимостей.