karkas/docs/DEV.md

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