tech-upd-recommender 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. tech_upd_recommender-0.1.0/.claude/settings.local.json +7 -0
  2. tech_upd_recommender-0.1.0/.git +1 -0
  3. tech_upd_recommender-0.1.0/.gitignore +57 -0
  4. tech_upd_recommender-0.1.0/CHECKLIST.md +139 -0
  5. tech_upd_recommender-0.1.0/CLAUDE.md +61 -0
  6. tech_upd_recommender-0.1.0/LICENSE +21 -0
  7. tech_upd_recommender-0.1.0/PKG-INFO +229 -0
  8. tech_upd_recommender-0.1.0/PLAN.md +378 -0
  9. tech_upd_recommender-0.1.0/README.md +172 -0
  10. tech_upd_recommender-0.1.0/docs/blocks/01-skeleton.md +137 -0
  11. tech_upd_recommender-0.1.0/docs/blocks/02-syft-module.md +135 -0
  12. tech_upd_recommender-0.1.0/docs/blocks/03-depsdev-module.md +152 -0
  13. tech_upd_recommender-0.1.0/docs/blocks/04-report-module.md +132 -0
  14. tech_upd_recommender-0.1.0/docs/blocks/05-llm-module.md +193 -0
  15. tech_upd_recommender-0.1.0/docs/blocks/06-integration.md +163 -0
  16. tech_upd_recommender-0.1.0/docs/tech-update-recommender.yaml.example +44 -0
  17. tech_upd_recommender-0.1.0/pyproject.toml +68 -0
  18. tech_upd_recommender-0.1.0/tech_update_recommender/__init__.py +5 -0
  19. tech_upd_recommender-0.1.0/tech_update_recommender/__main__.py +6 -0
  20. tech_upd_recommender-0.1.0/tech_update_recommender/cache.py +117 -0
  21. tech_upd_recommender-0.1.0/tech_update_recommender/cli.py +294 -0
  22. tech_upd_recommender-0.1.0/tech_update_recommender/config.py +170 -0
  23. tech_upd_recommender-0.1.0/tech_update_recommender/depsdev_module.py +596 -0
  24. tech_upd_recommender-0.1.0/tech_update_recommender/llm_module.py +711 -0
  25. tech_upd_recommender-0.1.0/tech_update_recommender/models.py +61 -0
  26. tech_upd_recommender-0.1.0/tech_update_recommender/report.py +337 -0
  27. tech_upd_recommender-0.1.0/tech_update_recommender/syft_module.py +281 -0
  28. tech_upd_recommender-0.1.0/tech_update_recommender/utils.py +104 -0
  29. tech_upd_recommender-0.1.0/tests/__init__.py +0 -0
  30. tech_upd_recommender-0.1.0/tests/conftest.py +61 -0
  31. tech_upd_recommender-0.1.0/tests/fixtures/cyclonedx_broken.json +12 -0
  32. tech_upd_recommender-0.1.0/tests/fixtures/cyclonedx_empty.json +22 -0
  33. tech_upd_recommender-0.1.0/tests/fixtures/cyclonedx_maven.json +47 -0
  34. tech_upd_recommender-0.1.0/tests/fixtures/cyclonedx_mixed.json +65 -0
  35. tech_upd_recommender-0.1.0/tests/fixtures/cyclonedx_simple.json +53 -0
  36. tech_upd_recommender-0.1.0/tests/fixtures/depsdev_404.json +5 -0
  37. tech_upd_recommender-0.1.0/tests/fixtures/depsdev_batch_response.json +60 -0
  38. tech_upd_recommender-0.1.0/tests/fixtures/depsdev_getpackage_express.json +35 -0
  39. tech_upd_recommender-0.1.0/tests/test_config.py +155 -0
  40. tech_upd_recommender-0.1.0/tests/test_depsdev_module.py +648 -0
  41. tech_upd_recommender-0.1.0/tests/test_integration.py +285 -0
  42. tech_upd_recommender-0.1.0/tests/test_llm_module.py +560 -0
  43. tech_upd_recommender-0.1.0/tests/test_models.py +161 -0
  44. tech_upd_recommender-0.1.0/tests/test_report.py +370 -0
  45. tech_upd_recommender-0.1.0/tests/test_syft_module.py +373 -0
@@ -0,0 +1,7 @@
1
+ {
2
+ "permissions": {
3
+ "allow": [
4
+ "Bash(python3 -m build)"
5
+ ]
6
+ }
7
+ }
@@ -0,0 +1 @@
1
+ gitdir: /Users/slavyan/Documents/ML/tech-update-recommender/.git/worktrees/funny-curie-1d77a6
@@ -0,0 +1,57 @@
1
+ # Python
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+ *.so
6
+ *.egg
7
+ *.egg-info/
8
+ dist/
9
+ build/
10
+ sdist/
11
+ wheels/
12
+ *.whl
13
+
14
+ # Virtual environments
15
+ .venv/
16
+ venv/
17
+ env/
18
+
19
+ # IDE
20
+ .idea/
21
+ .vscode/
22
+ *.swp
23
+ *.swo
24
+ *~
25
+ .project
26
+ .settings/
27
+
28
+ # Testing
29
+ .pytest_cache/
30
+ .coverage
31
+ htmlcov/
32
+ .tox/
33
+ .nox/
34
+
35
+ # Type checking
36
+ .mypy_cache/
37
+ .pytype/
38
+
39
+ # Linting
40
+ .ruff_cache/
41
+
42
+ # Distribution / packaging
43
+ *.tar.gz
44
+ *.zip
45
+
46
+ # Environment variables / secrets
47
+ .env
48
+ .env.*
49
+ !.env.example
50
+
51
+ # Project-specific
52
+ *.tech-update-recommender-cache/
53
+
54
+ # OS
55
+ .DS_Store
56
+ Thumbs.db
57
+ .DS_Store
@@ -0,0 +1,139 @@
1
+ # Tech Update Recommender — Чеклист реализации
2
+
3
+ Заполняется по мере работы. Подробности по каждому блоку — в `docs/blocks/`.
4
+
5
+ Легенда: `[ ]` — не начато, `[~]` — в работе, `[x]` — готово.
6
+
7
+ ---
8
+
9
+ ## Блок 1 — Скелет проекта
10
+ > Подробности: [docs/blocks/01-skeleton.md](docs/blocks/01-skeleton.md)
11
+
12
+ - [x] `pyproject.toml` создан и валиден
13
+ - [x] Структура директорий создана (`tech_update_recommender/`, `tests/`, `docs/`, `tests/fixtures/`)
14
+ - [x] `tech_update_recommender/__init__.py` с `__version__`
15
+ - [x] `models.py`: `PackageInfo`, `Advisory`, `DependencyReport`, `FullReport`, `LLMInput`
16
+ - [x] `config.py`: `Config` + `load_config()` с каскадом дефолтов
17
+ - [x] `cli.py`: `click`-команда `scan` со всеми опциями (заглушки)
18
+ - [x] `--version` работает
19
+ - [x] Логирование настроено (`--verbose` → DEBUG)
20
+ - [x] `pip install -e ".[llm,dev]"` проходит
21
+ - [x] `tests/test_models.py` — минимальные тесты моделей
22
+ - [x] `tests/test_config.py` — каскад конфигурации
23
+ - [x] `pytest -q` зелёный
24
+
25
+ ---
26
+
27
+ ## Блок 2 — SyftModule
28
+ > Подробности: [docs/blocks/02-syft-module.md](docs/blocks/02-syft-module.md)
29
+
30
+ - [x] `find_syft_binary()` + `SyftNotFoundError`
31
+ - [x] `run_syft()` через `subprocess`, stdout во временный файл
32
+ - [x] `SyftExecutionError` при ненулевом exit
33
+ - [x] `parse_cyclonedx()` — извлечение purl, парсинг через `packageurl-python`
34
+ - [x] Maven namespace склеивается корректно (`groupId:artifactId`)
35
+ - [x] `SUPPORTED_ECOSYSTEMS` константа
36
+ - [x] `split_supported()` — разделение на supported/unsupported
37
+ - [x] Дедупликация пакетов
38
+ - [x] Публичная функция `scan_project()`
39
+ - [x] Иерархия исключений (`SyftError`, `SyftNotFoundError`, `SyftExecutionError`, `SyftParseError`)
40
+ - [x] Фикстуры: `cyclonedx_simple.json`, `_mixed.json`, `_maven.json`, `_empty.json`, `_broken.json`
41
+ - [x] `tests/test_syft_module.py` — все тест-кейсы из блока 2
42
+
43
+ ---
44
+
45
+ ## Блок 3 — DepsDevModule
46
+ > Подробности: [docs/blocks/03-depsdev-module.md](docs/blocks/03-depsdev-module.md)
47
+
48
+ - [x] Async HTTP-клиент с таймаутом и retry (3 попытки, exp backoff)
49
+ - [x] `fetch_current_versions()` — batch POST `/v3alpha/versionbatch`
50
+ - [x] Чанкирование при > 5000 пакетов
51
+ - [x] `fetch_latest_versions()` — GET `/v3/systems/{system}/packages/{name}` параллельно
52
+ - [x] Семафор concurrency = 20
53
+ - [x] Дедупликация запросов GetPackage по `(system, name)`
54
+ - [x] `compute_semver_diff()` в `utils.py` — major/minor/patch/None
55
+ - [x] Поддержка нестрогого SemVer (Maven, PyPI)
56
+ - [x] `cache.py`: SQLite-кеш с TTL
57
+ - [x] `Cache.get/set/clear` API
58
+ - [x] `build_report()` — основная функция модуля
59
+ - [x] Корректные `outdated_count`, `vulnerable_count`
60
+ - [x] Обработка 404 (latest_version=None)
61
+ - [x] `DepsDevError` при недоступности API
62
+ - [x] Нормализация имён (PyPI lowercase, Maven groupId:artifactId)
63
+ - [x] Фикстуры: `depsdev_batch_response.json`, `depsdev_getpackage_express.json`, `depsdev_404.json`
64
+ - [x] `tests/test_depsdev_module.py` — все тест-кейсы из блока 3
65
+
66
+ ---
67
+
68
+ ## Блок 4 — ReportModule
69
+ > Подробности: [docs/blocks/04-report-module.md](docs/blocks/04-report-module.md)
70
+
71
+ - [x] `render_report()` — публичный API
72
+ - [x] Формат `table` через `rich.table.Table`
73
+ - [x] Цвета: красный/жёлтый/зелёный/серый по статусу
74
+ - [x] Summary-строка перед таблицей
75
+ - [x] Секция unsupported с кратким упоминанием
76
+ - [x] Формат `json` через `model_dump_json(indent=2)`
77
+ - [x] Поле `llm_advice` в JSON-выводе при наличии
78
+ - [x] Формат `markdown` с заголовками и таблицей
79
+ - [x] Дисклеймер LLM-секции с подстановкой `{model_name}`
80
+ - [x] Фильтр `only_outdated` применяется до рендера
81
+ - [x] Summary считается по полному отчёту (не по фильтру)
82
+ - [x] `tests/test_report.py` — все тест-кейсы из блока 4
83
+
84
+ ---
85
+
86
+ ## Блок 5 — LLMModule
87
+ > Подробности: [docs/blocks/05-llm-module.md](docs/blocks/05-llm-module.md)
88
+
89
+ - [x] `collect_project_tree()` — обход с исключениями (`node_modules`, `.git`, `venv`, …)
90
+ - [x] Лимит строк дерева (default 200)
91
+ - [x] `collect_dependency_files()` — поиск стандартных файлов
92
+ - [x] Пропуск lock-файлов > 200 KB
93
+ - [x] `build_llm_input()` — top-50 outdated/vulnerable
94
+ - [x] Приоритизация: CVE → major → minor → patch
95
+ - [x] System prompt из PLAN.md
96
+ - [x] User prompt с отчётом, деревом, файлами
97
+ - [x] Подсчёт токенов через `litellm.token_counter` или fallback
98
+ - [x] Алгоритм усечения при превышении `max_context_tokens`
99
+ - [x] `LLMContextOverflowError` если усечение не помогло
100
+ - [x] `generate_advice()` через `litellm.completion`
101
+ - [x] Ленивый импорт `litellm`
102
+ - [x] `LLMNotAvailableError` при отсутствии зависимости
103
+ - [x] Маппинг ошибок: `LLMAuthError`, `LLMRateLimitError`, `LLMNetworkError`
104
+ - [x] Retry на rate limit (1 попытка через 5 сек)
105
+ - [x] API-ключи не попадают в логи
106
+ - [x] Поддержка локальных моделей (Ollama) без API-ключа
107
+ - [x] `tests/test_llm_module.py` — все тест-кейсы из блока 5
108
+
109
+ ---
110
+
111
+ ## Блок 6 — Интеграция и финализация
112
+ > Подробности: [docs/blocks/06-integration.md](docs/blocks/06-integration.md)
113
+
114
+ - [x] CLI pipeline `scan` склеен (Syft → DepsDev → LLM → Report)
115
+ - [x] Прогресс-бары через `rich.progress` (в stderr)
116
+ - [x] Обработка ошибок верхнего уровня в `main()`, корректные exit codes
117
+ - [x] Ошибка при `--mode advice/full` без указанной модели
118
+ - [x] Конфиг `~/.tech-update-recommender.yaml` загружается, если есть
119
+ - [x] `docs/tech-update-recommender.yaml.example` создан
120
+ - [x] `README.md` написан (установка, quickstart, режимы, конфиг, env vars, ограничения)
121
+ - [x] `CLAUDE.md` создан (карта модулей, контракты, тесты)
122
+ - [x] `LICENSE` (MIT) в корне
123
+ - [x] `tests/test_integration.py` — full pipeline с моками
124
+ - [x] `ruff check .` + `ruff format --check .` зелёные
125
+ - [ ] Ручной прогон на 2–3 реальных проектах разных экосистем
126
+ - [x] Версия 0.1.0 в `pyproject.toml`
127
+ - [x] `python -m build` создаёт wheel + sdist
128
+ - [x] `twine check dist/*` без ошибок
129
+
130
+ ---
131
+
132
+ ## Сквозные требования (проверять в течение всех блоков)
133
+
134
+ - [x] Все публичные функции имеют type hints
135
+ - [x] Никаких `print()` для статусной информации (только `logging`)
136
+ - [x] API-ключи никогда не логируются
137
+ - [x] Все внешние вызовы (subprocess, HTTP) обёрнуты в try/except
138
+ - [x] Тесты не требуют установленного syft и доступа к интернету
139
+ - [x] `pytest -q` зелёный после каждого блока
@@ -0,0 +1,61 @@
1
+ # CLAUDE.md — ориентир для агентов
2
+
3
+ Краткий справочник по структуре Tech Update Recommender, контрактам между модулями и
4
+ правилам, которым нужно следовать при доработке.
5
+
6
+ ## Карта модулей
7
+
8
+ | Файл | Что делает |
9
+ |------|------------|
10
+ | `tech_update_recommender/__init__.py` | Экспортирует `__version__`. |
11
+ | `tech_update_recommender/__main__.py` | `python -m tech_update_recommender` → `cli.main`. |
12
+ | `tech_update_recommender/cli.py` | Click-команда `scan`, склейка pipeline, обработка ошибок верхнего уровня. |
13
+ | `tech_update_recommender/config.py` | Pydantic-конфиг + каскад «CLI > env > yaml > defaults», `ConfigError`. |
14
+ | `tech_update_recommender/cache.py` | SQLite-кеш `(system, name, version) → JSON` с TTL. |
15
+ | `tech_update_recommender/models.py` | Pydantic-модели контрактов: `PackageInfo`, `DependencyReport`, `FullReport`, `LLMInput`, `Advisory`. |
16
+ | `tech_update_recommender/syft_module.py` | Запуск syft, парсинг CycloneDX, фильтр по `SUPPORTED_ECOSYSTEMS`, `SyftError`. |
17
+ | `tech_update_recommender/depsdev_module.py` | Async HTTP к deps.dev (batch + GetPackage), `build_report`, `DepsDevError`. |
18
+ | `tech_update_recommender/llm_module.py` | Сбор контекста (tree + dep-файлы), промпт, `litellm.completion`, `LLMError`. |
19
+ | `tech_update_recommender/report.py` | Рендер `FullReport` в `table` / `json` / `markdown`. |
20
+ | `tech_update_recommender/utils.py` | semver-сравнение, нормализация PyPI-имён, URL-кодирование. |
21
+
22
+ ## Контракты между модулями (одной строкой)
23
+
24
+ - `scan_project(path) -> (supported, unsupported)` — оба списка `PackageInfo`.
25
+ - `build_report(supported, unsupported, project_path, cache) -> FullReport` (async).
26
+ - `build_llm_input(report, project_path) -> LLMInput`.
27
+ - `generate_advice(llm_input, model, api_key=None, max_context_tokens=8000) -> str` (markdown).
28
+ - `render_report(report, fmt, only_outdated=False, llm_advice=None, llm_model_name=None) -> str`.
29
+
30
+ Pipeline: Syft → deps.dev (+ Cache) → LLM (опц.) → Report → stdout/файл.
31
+
32
+ ## Команды разработчика
33
+
34
+ ```bash
35
+ pytest -q # все тесты (юнит + интеграционные)
36
+ ruff check . # линтер: E, F, I, B
37
+ ruff format --check . # форматирование
38
+ python -m build # сборка wheel + sdist
39
+ twine check dist/* # метаданные
40
+ ```
41
+
42
+ ## Что НЕ делать
43
+
44
+ - Не печатать API-ключи в логах. `SecretStr` уже маскирует — не вытаскивайте
45
+ значение в логгер. В `generate_advice` ключ не логируется (см. блок 5).
46
+ - Не превращать pipeline в agentic / tool-using. Tech Update Recommender делает один
47
+ LLM-вызов с собранным заранее контекстом — и всё. Без циклов «LLM зовёт
48
+ инструменты».
49
+ - Не делать реальные HTTP/syft-вызовы в тестах. Используйте `aioresponses`
50
+ для deps.dev и моки `subprocess.run` / `scan_project` для syft.
51
+ - Не лить `print()` для статуса — только `logging`. Прогресс — через
52
+ `rich.progress.Progress` и `Console(stderr=True)`.
53
+ - Не трогать `cli` стайл вывода: stdout = только результат отчёта, stderr =
54
+ прогресс / сообщения / ошибки. Иначе `--output json` в pipe сломается.
55
+ - Не публиковать на PyPI без явной просьбы. `python -m build` и
56
+ `twine check` — да; `twine upload` — нет.
57
+
58
+ ## Версионирование
59
+
60
+ Версия в `tech_update_recommender/__init__.py` и `pyproject.toml` должна совпадать.
61
+ Текущая релизная — `0.1.0`.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 DepScope contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,229 @@
1
+ Metadata-Version: 2.4
2
+ Name: tech-upd-recommender
3
+ Version: 0.1.0
4
+ Summary: Open-source CLI utility for local dependency analysis with AI-powered update recommendations.
5
+ Project-URL: Homepage, https://github.com/Alimhux/tech-update-recommender
6
+ Project-URL: Issues, https://github.com/Alimhux/tech-update-recommender/issues
7
+ Author-email: Alimhux <slavyan1011@gmail.com>
8
+ License: MIT License
9
+
10
+ Copyright (c) 2025 DepScope contributors
11
+
12
+ Permission is hereby granted, free of charge, to any person obtaining a copy
13
+ of this software and associated documentation files (the "Software"), to deal
14
+ in the Software without restriction, including without limitation the rights
15
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16
+ copies of the Software, and to permit persons to whom the Software is
17
+ furnished to do so, subject to the following conditions:
18
+
19
+ The above copyright notice and this permission notice shall be included in all
20
+ copies or substantial portions of the Software.
21
+
22
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28
+ SOFTWARE.
29
+ License-File: LICENSE
30
+ Keywords: cli,dependencies,deps.dev,sbom,security,syft
31
+ Classifier: Development Status :: 3 - Alpha
32
+ Classifier: Environment :: Console
33
+ Classifier: Intended Audience :: Developers
34
+ Classifier: License :: OSI Approved :: MIT License
35
+ Classifier: Operating System :: OS Independent
36
+ Classifier: Programming Language :: Python :: 3
37
+ Classifier: Programming Language :: Python :: 3.11
38
+ Classifier: Programming Language :: Python :: 3.12
39
+ Classifier: Topic :: Security
40
+ Classifier: Topic :: Software Development
41
+ Requires-Python: >=3.11
42
+ Requires-Dist: aiohttp
43
+ Requires-Dist: certifi
44
+ Requires-Dist: click
45
+ Requires-Dist: litellm
46
+ Requires-Dist: packageurl-python
47
+ Requires-Dist: packaging
48
+ Requires-Dist: pydantic>=2
49
+ Requires-Dist: pyyaml
50
+ Requires-Dist: rich
51
+ Provides-Extra: dev
52
+ Requires-Dist: aioresponses; extra == 'dev'
53
+ Requires-Dist: pytest; extra == 'dev'
54
+ Requires-Dist: pytest-asyncio; extra == 'dev'
55
+ Requires-Dist: ruff; extra == 'dev'
56
+ Description-Content-Type: text/markdown
57
+
58
+ # Tech Update Recommender
59
+
60
+ Tech Update Recommender — open-source CLI-утилита для локального анализа зависимостей проекта.
61
+ Она находит application-level зависимости через [Syft](https://github.com/anchore/syft),
62
+ проверяет их версии и известные уязвимости через [deps.dev](https://deps.dev),
63
+ и опционально генерирует AI-рекомендации по обновлению через
64
+ [LiteLLM](https://github.com/BerriAI/litellm).
65
+
66
+ Ключевые возможности:
67
+
68
+ - Локально, без отправки исходного кода на сервер.
69
+ - Поддержка ecosystem'ов npm, PyPI, Maven, Go, Cargo, RubyGems, NuGet.
70
+ - Кеш ответов deps.dev (SQLite, TTL 1 час) — повторные запуски быстрые.
71
+ - Несколько форматов вывода: `table` (rich), `json`, `markdown`.
72
+ - Выбор LLM-провайдера через LiteLLM (Anthropic / OpenAI / Gemini / Ollama).
73
+
74
+ ## Установка
75
+
76
+ Tech Update Recommender требует Python 3.11+.
77
+
78
+ ```bash
79
+ # Из PyPI:
80
+ pip install tech-update-recommender[llm]
81
+ # или через pipx:
82
+ pipx install "tech-update-recommender[llm]"
83
+
84
+ # Из исходников (для разработки):
85
+ pip install -e ".[llm]"
86
+ ```
87
+
88
+ Группа `[llm]` ставит `litellm`. Без неё Tech Update Recommender работает в режимах
89
+ `report` (без LLM) и просто возвращает понятную ошибку, если запросить
90
+ `advice`/`full`.
91
+
92
+ ### Установка Syft
93
+
94
+ Tech Update Recommender не пытается тянуть Syft в зависимостях — этот инструмент удобнее
95
+ ставить системно.
96
+
97
+ ```bash
98
+ # macOS:
99
+ brew install syft
100
+
101
+ # Linux / любой UNIX (официальный установщик):
102
+ curl -sSfL https://raw.githubusercontent.com/anchore/syft/main/install.sh | sh -s -- -b /usr/local/bin
103
+ ```
104
+
105
+ Если syft установлен в нестандартное место — передайте путь через
106
+ `--syft-path` или поле `syft.path` в `~/.tech-update-recommender.yaml`.
107
+
108
+ ## Quickstart
109
+
110
+ ```bash
111
+ # 1. Простой отчёт по фактам (без LLM):
112
+ tech-update-recommender scan ./my-project
113
+
114
+ # 2. Полный отчёт с AI-рекомендациями:
115
+ tech-update-recommender scan ./my-project --mode full \
116
+ --llm-model gemini/gemini-2.0-flash
117
+
118
+ # 3. JSON в файл:
119
+ tech-update-recommender scan ./my-project --output json --save out.json
120
+ ```
121
+
122
+ ## Режимы работы
123
+
124
+ | Режим | Что делает |
125
+ |----------|----------------------------------------------------------------------|
126
+ | `report` | (default) только факты: версии, дельты semver, advisories. |
127
+ | `advice` | только AI-рекомендации (без таблицы фактов в LLM-секции — но summary остаётся). |
128
+ | `full` | факты + AI-рекомендации. |
129
+
130
+ Режимы `advice` и `full` требуют указать LLM-модель (через CLI-аргумент,
131
+ env var или конфиг). Без модели Tech Update Recommender сообщит ошибку конфигурации
132
+ (`exit code 5`) и подскажет, что делать.
133
+
134
+ Флаг `--no-llm` принудительно понижает режим до `report` — удобно,
135
+ если конфиг по умолчанию содержит модель, но прямо сейчас не хочется
136
+ дёргать API.
137
+
138
+ ## Конфигурационный файл
139
+
140
+ Путь по умолчанию: `~/.tech-update-recommender.yaml`. Файл опционален — при отсутствии
141
+ используются значения по умолчанию.
142
+
143
+ Пример полной структуры см. в `docs/tech-update-recommender.yaml.example`. Минимальный
144
+ вариант:
145
+
146
+ ```yaml
147
+ llm:
148
+ model: "gemini/gemini-2.0-flash"
149
+ max_context_tokens: 8000
150
+
151
+ cache:
152
+ enabled: true
153
+ ttl_seconds: 3600
154
+ path: "~/.cache/tech-update-recommender/"
155
+ ```
156
+
157
+ API-ключи лучше держать в env vars, а не в файле. Если всё-таки храните
158
+ в файле — `chmod 600 ~/.tech-update-recommender.yaml`.
159
+
160
+ ## Переменные окружения
161
+
162
+ | Переменная | Что задаёт |
163
+ |-------------------------|---------------------------------------------------------|
164
+ | `TUR_LLM_MODEL` | Имя LLM-модели (как `--llm-model`). |
165
+ | `TUR_LLM_API_KEY` | Универсальный API-ключ. |
166
+ | `ANTHROPIC_API_KEY` | Используется, если `TUR_LLM_API_KEY` не задан. |
167
+ | `OPENAI_API_KEY` | То же самое. |
168
+ | `GEMINI_API_KEY` | То же самое. |
169
+ | `TUR_SYFT_PATH` | Путь к бинарнику syft (как `--syft-path`). |
170
+
171
+ Каскад приоритетов значений (от высшего к низшему):
172
+ CLI > env vars > `~/.tech-update-recommender.yaml` > дефолты.
173
+
174
+ ## Поддерживаемые экосистемы
175
+
176
+ Экосистемы, для которых Tech Update Recommender умеет проверять версии и advisories
177
+ через deps.dev:
178
+
179
+ - `npm`
180
+ - `pypi`
181
+ - `maven`
182
+ - `golang`
183
+ - `cargo`
184
+ - `gem` (RubyGems)
185
+ - `nuget`
186
+
187
+ Системные пакеты (`deb`, `apk`, `rpm` и т.п.), найденные Syft, не
188
+ проверяются — они показываются отдельной секцией «Не проверено через
189
+ deps.dev» (это ограничение API deps.dev, а не Tech Update Recommender).
190
+
191
+ ## Известные ограничения
192
+
193
+ - **Syft требует lock-файлы.** Если в проекте только `requirements.txt`
194
+ без зафиксированных версий или без lock-файла — Syft найдёт меньше
195
+ зависимостей, чем хотелось бы.
196
+ - **deps.dev не знает системные пакеты.** Контейнерные пакеты (deb / apk
197
+ / rpm) выводятся отдельной секцией без проверки на устаревание/CVE.
198
+ - **deps.dev v3alpha может меняться.** Batch endpoint используется для
199
+ получения advisories текущих версий; в случае поломки API — Tech Update Recommender
200
+ выдаст понятную ошибку и не упадёт с traceback.
201
+ - **LLM не гарантирует корректность рекомендаций.** Это всегда advisory:
202
+ проверяйте совместимость и тестируйте обновления.
203
+ - **Нормализация имён пакетов.** PyPI нормализует имена
204
+ (`Flask-Babel` → `flask-babel`). Tech Update Recommender делает это на своей стороне
205
+ для запросов и кеша.
206
+
207
+ ## Коды возврата
208
+
209
+ | Код | Значение |
210
+ |-----|-----------------------------------------------------------|
211
+ | 0 | Успех. |
212
+ | 1 | Любая прочая ошибка (с подсказкой использовать `--verbose`). |
213
+ | 2 | Ошибка Syft (`SyftError`). |
214
+ | 3 | Ошибка deps.dev (`DepsDevError`). |
215
+ | 4 | Ошибка LLM (`LLMError` и его подклассы). |
216
+ | 5 | Ошибка конфигурации (`ConfigError`). |
217
+ | 130 | Отменено пользователем (`Ctrl+C`). |
218
+
219
+ ## Тесты и линтер
220
+
221
+ ```bash
222
+ pytest -q
223
+ ruff check .
224
+ ruff format --check .
225
+ ```
226
+
227
+ ## Лицензия
228
+
229
+ MIT — см. файл [`LICENSE`](LICENSE).