|
| 1 | +# 📄 **Полная документация по командам проекта и GitHub Workflows** |
| 2 | + |
| 3 | +## 🚀 Команды для разработки, тестирования и безопасности |
| 4 | + |
| 5 | +Ниже приведён набор команд, которые используются в проекте для локальной разработки, статического анализа, тестирования, проверки безопасности и интеграции с GitHub Actions. |
| 6 | + |
| 7 | +--- |
| 8 | + |
| 9 | +## 📦 Установка зависимостей |
| 10 | + |
| 11 | +Проект использует **uv** (современная замена pip/virtualenv). |
| 12 | + |
| 13 | +```bash |
| 14 | +python -m pip install --upgrade pip |
| 15 | +pip install --upgrade uv |
| 16 | +``` |
| 17 | + |
| 18 | +Установка всех зависимостей: |
| 19 | + |
| 20 | +```bash |
| 21 | +uv sync |
| 22 | +``` |
| 23 | + |
| 24 | +--- |
| 25 | + |
| 26 | +## 🧹 Pre-commit Hooks |
| 27 | + |
| 28 | +В проекте настроены pre-commit хуки: |
| 29 | + |
| 30 | +* ruff |
| 31 | +* black |
| 32 | +* mypy |
| 33 | +* detect-secrets |
| 34 | +* pre-commit-hooks (basic) |
| 35 | +* etc. |
| 36 | + |
| 37 | +### Установить хуки: |
| 38 | + |
| 39 | +```bash |
| 40 | +uv run pre-commit install |
| 41 | +``` |
| 42 | + |
| 43 | +### Обновить версии хуков: |
| 44 | + |
| 45 | +```bash |
| 46 | +uv run pre-commit autoupdate |
| 47 | +``` |
| 48 | + |
| 49 | +### Очистить кэш: |
| 50 | + |
| 51 | +```bash |
| 52 | +uv run pre-commit clean |
| 53 | +``` |
| 54 | + |
| 55 | +### Запуск проверки всех файлов: |
| 56 | + |
| 57 | +```bash |
| 58 | +uv run pre-commit run --all-files |
| 59 | +``` |
| 60 | + |
| 61 | +--- |
| 62 | + |
| 63 | +## 🔐 Поиск секретов (detect-secrets) |
| 64 | + |
| 65 | +Сканирование на утечку токенов: |
| 66 | + |
| 67 | +```bash |
| 68 | +uv run detect-secrets scan |
| 69 | +``` |
| 70 | + |
| 71 | +Создание baseline (если нет файла): |
| 72 | + |
| 73 | +```bash |
| 74 | +uv run detect-secrets scan > .secrets.baseline |
| 75 | +git add .secrets.baseline |
| 76 | +``` |
| 77 | + |
| 78 | +Проверка новых коммитов: |
| 79 | + |
| 80 | +```bash |
| 81 | +uv run pre-commit run detect-secrets |
| 82 | +``` |
| 83 | + |
| 84 | +--- |
| 85 | + |
| 86 | +## 🔎 Анализ безопасности кода |
| 87 | + |
| 88 | +В проекте используются несколько security-инструментов. |
| 89 | + |
| 90 | +### 1. pip-audit — аудит зависимостей |
| 91 | + |
| 92 | +Проверка уязвимых Python-пакетов: |
| 93 | + |
| 94 | +```bash |
| 95 | +uv run pip-audit |
| 96 | +``` |
| 97 | + |
| 98 | +--- |
| 99 | + |
| 100 | +### 2. Bandit — статический анализ Python-кода |
| 101 | + |
| 102 | +Запуск проверки: |
| 103 | + |
| 104 | +```bash |
| 105 | +uv run bandit -r src -ll |
| 106 | +``` |
| 107 | + |
| 108 | +--- |
| 109 | + |
| 110 | +### 3. Safety — проверка зависимостей по базе CVE |
| 111 | + |
| 112 | +```bash |
| 113 | +uv run safety check |
| 114 | +``` |
| 115 | + |
| 116 | +--- |
| 117 | + |
| 118 | +## 🧪 Тесты (pytest) |
| 119 | + |
| 120 | +Запуск всех тестов: |
| 121 | + |
| 122 | +```bash |
| 123 | +uv run pytest -v |
| 124 | +``` |
| 125 | + |
| 126 | +Быстрый прогон: |
| 127 | + |
| 128 | +```bash |
| 129 | +uv run pytest -q |
| 130 | +``` |
| 131 | + |
| 132 | +Запуск с coverage: |
| 133 | + |
| 134 | +```bash |
| 135 | +uv run pytest --cov=src --cov-report=term-missing |
| 136 | +``` |
| 137 | + |
| 138 | +--- |
| 139 | + |
| 140 | +## 🧹 Линтинг и форматирование |
| 141 | + |
| 142 | +### Ruff — линтер и auto-fix |
| 143 | + |
| 144 | +Проверка: |
| 145 | + |
| 146 | +```bash |
| 147 | +uv run ruff check src/ |
| 148 | +``` |
| 149 | + |
| 150 | +Исправление: |
| 151 | + |
| 152 | +```bash |
| 153 | +uv run ruff check src/ --fix |
| 154 | +``` |
| 155 | + |
| 156 | +--- |
| 157 | + |
| 158 | +### Black — автоформатирование |
| 159 | + |
| 160 | +Проверка: |
| 161 | + |
| 162 | +```bash |
| 163 | +uv run black --check src/ |
| 164 | +``` |
| 165 | + |
| 166 | +Форматирование: |
| 167 | + |
| 168 | +```bash |
| 169 | +uv run black src/ |
| 170 | +``` |
| 171 | + |
| 172 | +--- |
| 173 | + |
| 174 | +### Mypy — статическая проверка типов |
| 175 | + |
| 176 | +```bash |
| 177 | +uv run mypy src/ |
| 178 | +``` |
| 179 | + |
| 180 | +--- |
| 181 | + |
| 182 | +## 🧰 Полный набор проверок перед коммитом |
| 183 | + |
| 184 | +```bash |
| 185 | +uv run pre-commit run --all-files |
| 186 | +uv run ruff check src/ --fix |
| 187 | +uv run black src/ |
| 188 | +uv run mypy src/ |
| 189 | +uv run pytest -v |
| 190 | +uv run pip-audit |
| 191 | +uv run bandit -r src -ll |
| 192 | +``` |
| 193 | + |
| 194 | +--- |
| 195 | + |
| 196 | +## 🔄 Полезные GitHub Actions Workflows |
| 197 | + |
| 198 | +### 🛡 CodeQL (Static Code Analysis) |
| 199 | + |
| 200 | +CodeQL запускается автоматически: |
| 201 | + |
| 202 | +* при push |
| 203 | +* при Pull Request |
| 204 | +* по расписанию |
| 205 | + |
| 206 | +Запуск вручную (через UI): |
| 207 | + |
| 208 | +``` |
| 209 | +Actions → CodeQL → Run workflow |
| 210 | +``` |
| 211 | + |
| 212 | +--- |
| 213 | + |
| 214 | +## 🤖 Dependabot |
| 215 | + |
| 216 | +Dependabot автоматически создаёт PR для: |
| 217 | + |
| 218 | +* Python зависимостей (`pip`) |
| 219 | +* GitHub Actions |
| 220 | + |
| 221 | +Чтобы обновить вручную: |
| 222 | + |
| 223 | +``` |
| 224 | +Settings → Code security and analysis → Dependabot |
| 225 | +``` |
| 226 | + |
| 227 | +--- |
| 228 | + |
| 229 | +## 📝 Перед Merge в main (checklist) |
| 230 | + |
| 231 | +Перед отправкой PR убедись, что: |
| 232 | + |
| 233 | +✔ тесты проходят |
| 234 | +✔ pre-commit не ругается |
| 235 | +✔ нет утечек секретов |
| 236 | +✔ ruff и black чистые |
| 237 | +✔ pip-audit без критических уязвимостей |
| 238 | +✔ bandit предупреждений нет или они обоснованы |
| 239 | +✔ CI зелёный |
| 240 | +✔ PR покрыт описанием |
0 commit comments