Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
118 lines (77 loc) · 4.8 KB

CONTRIBUTING.md

File metadata and controls

118 lines (77 loc) · 4.8 KB

Разработчикам бэкенда

[TOC]

Как развернуть локально

Необходимое ПО

Для запуска ПО вам понадобятся консольный Git и Make. Инструкции по их установке ищите на официальных сайтах:

Вы можете проверить, установлены ли эти программы с помощью команд:

$ git --version
git version 2.37.1.windows.1

$ make --version
GNU Make 4.4.1
Built for Windows32
<...>

Для тех, кто использует Windows необходимы также программы git и git bash. В git bash необходимо дополнительно установить make:

  • Перейдите на сайт ezwinports
  • Скачайте make-4.4.1-without-guile-w32-bin.zip (выберите версию без guile)
  • Извлеките архив
  • Скопируйте содержимое архива в C:\ProgramFiles\Git\mingw64\ БЕЗ перезаписи/замены любых вложенных файлов.

Все дальнейшие команды запускать из-под git bash.

Создание виртуального окружения для работы с IDE

IDE для корректной работы подсказок необходимо развернуть виртуальное окружение со всеми установленными зависимостями.

В качестве пакетного менеджера на проекта используется uv.

Установите uv и в корне репозитория выполните команду

$ uv sync

uv создаст виртуальное окружение, установит необходимую версию Python и все необходимые зависимости.

После этого активируйте виртуальное окружение в текущей сессии терминала:

$ source .venv/bin/activate  # для Linux
$ .\.venv\Scripts\activate  # Для Windows

Настройка pre-commit хуков

В репозитории используются хуки pre-commit, чтобы автоматически запускать линтеры и автотесты.

В корне репозитория в активированном виртуальном окружении запустите команду для настройки хуков:

$ pre-commit install
pre-commit installed at .git/hooks/pre-commit

В последующем при коммите автоматически будут запускаться линтеры и другие проверки. Если проверки не пройдут, то коммит прервётся с ошибкой.

Если вам потребуется сделать коммит без проверок, то вы можете отключить их с помощью флага --no-verify:

git commit -m 'Message' --no-verify

Как вести разработку

Код проекта находится в папке /src.

Находясь в корневой директории проекта, запустить проект можно командой:

$ fastapi dev src/main.py

Проект будет работать по адресу http://127.0.0.1:8000/

Как установить python-пакет в виртуальное окружение

В качестве менеджера пакетов используется uv.

Вот пример как добавить в зависимости библиотеку beautifulsoup4.

$ uv add beautifulsoup4

Конфигурационные файлы pyproject.toml и uv.lock обновятся автоматически.

Аналогичным образом можно удалять python-пакеты:

$ uv remove beautifulsoup4

Если необходимо обновить uv.lock вручную, то используйте команду:

$ uv lock

Команды для быстрого запуска с помощью make

Для вывода списка часто используемых коротких команд используйте команду

$ make list
...