Установка

В этом руководстве представлена вся необходимая информация для установки CulicidaeLab. Мы рассмотрим простую установку для обычных пользователей и полную настройку для разработки для тех, кто хочет внести свой вклад в проект.

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

Прежде чем начать, убедитесь, что на вашей системе установлено следующее:

• Python 3.11 или выше
• pip (установщик пакетов Python, обычно поставляется вместе с Python)
• Git (для настройки разработки)

Стандартная установка (для пользователей)

Это рекомендуемый подход для большинства пользователей, которые хотят использовать CulicidaeLab в своих проектах. Он установит последнюю стабильную версию из Python Package Index (PyPI).

Мы настоятельно рекомендуем работать в виртуальном окружении, чтобы избежать конфликтов с другими проектами или системными пакетами.

Рекомендуется: Использование uv

uv — это чрезвычайно быстрый, современный установщик и сопоставитель пакетов Python, который может заменить pip и venv.

# 1. Создайте и активируйте виртуальное окружение
uv venv

# На macOS/Linux:
source .venv/bin/activate
# На Windows:
# .venv\Scripts\activate

# 2. Установите библиотеку
uv add culicidaelab

Альтернатива: Использование pip и venv

Если вы предпочитаете использовать стандартные инструменты, встроенные в Python:

# 1. Создайте виртуальное окружение
python -m venv .venv

# 2. Активируйте его
# На macOS/Linux:
source .venv/bin/activate
# На Windows:
# .venv\Scripts\activate

# 3. Установите библиотеку с помощью pip
pip install culicidaelab

Настройка для разработки (для контрибьюторов)

Если вы планируете внести свой вклад в CulicidaeLab, исправить ошибку или добавить новую функцию, вам потребуется настроить среду разработки. Это включает в себя клонирование репозитория и установку проекта в редактируемом режиме.

1. Сделайте форк репозитория Начните с создания форка основного репозитория на GitHub в ваш собственный аккаунт.

2. Клонируйте свой форк Клонируйте свой форкнутый репозиторий на локальную машину:

   git clone https://github.com/YOUR_USERNAME/culicidaelab.git
   cd culicidaelab
   

3. Создайте и активируйте виртуальное окружение Виртуальное окружение необходимо для разработки, чтобы изолировать ваши зависимости.

   # Используя uv (рекомендуется для скорости)
   uv venv
   
   # Или используя встроенный в Python venv
   # python -m venv .venv
   
   # Активируйте окружение
   # На macOS/Linux:
   source .venv/bin/activate
   # На Windows:
   # .venv\Scripts\activate
   

4. Установите зависимости в редактируемом режиме Установите проект с дополнением [dev], которое включает все инструменты, необходимые для тестирования, линтинга и документирования. Флаг -e устанавливает его в «редактируемом» режиме, что означает, что изменения, которые вы вносите в исходный код, вступят в силу немедленно без необходимости переустановки.

   # Эта команда устанавливает библиотеку и все зависимости для разработки
   uv pip install -e ".[dev]"
   

5. Настройте pre-commit хуки Мы используем pre-commit для автоматического запуска проверок качества кода перед каждым коммитом. Это одноразовый шаг настройки для каждого клона проекта.

   pre-commit install
   

   Теперь, когда вы будете выполнять git commit, наши форматеры кода и линтеры будут запускаться автоматически, обеспечивая соответствие ваших вкладов стандартам проекта.

Проверка установки

Чтобы убедиться, что CulicidaeLab был установлен правильно, вы можете запустить следующий фрагмент кода на Python:

try:
    from culicidaelab import get_settings
    settings = get_settings()
    print("✅ Установка CulicidaeLab прошла успешно!")
    print(f"Каталог моделей по умолчанию: {settings.model_dir}")
except ImportError:
    print("❌ Установка CulicidaeLab не удалась. Пожалуйста, проверьте шаги выше.")

Все готово! Теперь вы готовы исследовать возможности библиотеки.