mirror of
https://gitflic.ru/project/maks1ms/ocab.git
synced 2024-12-25 00:54:42 +03:00
40 lines
2.4 KiB
Markdown
40 lines
2.4 KiB
Markdown
## Настройка рабочего окружения
|
||
|
||
Данная инструкция поможет вам настроить рабочее окружение для разработки OCAB.
|
||
|
||
### Предварительные требования
|
||
|
||
* **Python 3.12:** OCAB требует Python 3.12.
|
||
* **VSCode:** Рекомендуется использовать VSCode для разработки.
|
||
* **Git:** У вас должен быть установлен Git для клонирования репозитория.
|
||
|
||
### Шаги
|
||
|
||
1. **Клонируйте репозиторий:**
|
||
```bash
|
||
git clone https://gitflic.ru/project/armatik/ocab.git
|
||
```
|
||
|
||
2. **Откройте проект в VSCode:**
|
||
* Откройте папку `ocab` в VSCode.
|
||
* VSCode автоматически предложит открыть проект как workspace, используя файл `ocab.code-workspace`.
|
||
Нажмите "Открыть Workspace", чтобы принять предложение.
|
||
|
||
3. **Настройте Poetry:**
|
||
* Установите Poetry, следуя инструкциям на официальном сайте: [https://python-poetry.org/docs/](https://python-poetry.org/docs/).
|
||
* **Для каждого пакета:**
|
||
* Перейдите в папку пакета (например, `src/ocab_core`).
|
||
* Выполните команду `poetry install`, чтобы установить зависимости пакета.
|
||
* Poetry создаст виртуальное окружение внутри папки пакета (`.venv`).
|
||
|
||
4. **Активируйте виртуальное окружение:**
|
||
* Выполните команду `poetry shell` в папке пакета, чтобы активировать виртуальное окружение.
|
||
|
||
Теперь ваше рабочее окружение настроено, и вы можете начать.
|
||
|
||
### Дополнительная информация
|
||
|
||
* Каждый пакет в монорепозитории имеет свой собственный файл `pyproject.toml`, где указаны его зависимости.
|
||
* Poetry автоматически управляет виртуальными окружениями для каждого пакета.
|
||
* Вы можете использовать команду `poetry add <package_name>` для добавления новых зависимостей.
|