diff --git a/README.md b/README.md index 2af9da1..27004b4 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ - Перевод статусов на русский язык - Простой CLI с понятными аргументами - Поддержка настройки диапазона дат по умолчанию через `.env` +- Экспорт в ODT с автоматическим заголовком (автор + месяц) --- @@ -59,6 +60,7 @@ cat /etc/ssl/certs/ca-certificates.crt >> $(python -m certifi) REDMINE_URL=https://red.eltex.loc/ REDMINE_USER=ваш.логин REDMINE_PASSWORD=ваш_пароль +REDMINE_AUTHOR=Иванов Иван Иванович # Опционально: диапазон дат по умолчанию DEFAULT_FROM_DATE=2026-01-01 @@ -71,6 +73,7 @@ DEFAULT_TO_DATE=2026-01-31 export REDMINE_URL=https://red.eltex.loc/ export REDMINE_USER=ваш.логин export REDMINE_PASSWORD=... +export REDMINE_AUTHOR="Иванов Иван Иванович" export DEFAULT_FROM_DATE=2026-01-01 export DEFAULT_TO_DATE=2026-01-31 ``` @@ -99,9 +102,32 @@ redmine-reporter --date 2026-02-01--2026-02-28 # Компактный вывод (удобно копировать в письмо) redmine-reporter --compact + +# Экспорт в ODT с указанием автора (если не задано в .env) +redmine-reporter --output report.odt --author "Иванов Иван Иванович" ``` -Пример вывода: +> 💡 **Автоматика в ODT-отчёте**: +> - Месяц в заголовке определяется **автоматически** по дате окончания периода (`to_date`). +> Например: `2025-12-20--2026-01-15` → **«Январь»**. +> - Имя автора берётся из переменной окружения `REDMINE_AUTHOR` (в `.env`) или CLI-аргумента `--author`. +> - Первая пустая строка из шаблона `template.odt` **автоматически удаляется**. + +Пример содержимого `.env` с автором: + +```ini +REDMINE_URL=https://red.eltex.loc/ +REDMINE_USER=ваш.логин +REDMINE_PASSWORD=ваш_пароль +REDMINE_AUTHOR=Иванов Иван Иванович +DEFAULT_FROM_DATE=2026-01-01 +DEFAULT_TO_DATE=2026-01-31 +``` + +Пример вывода в ODT (заголовок): +> **Иванов Иван Иванович. Отчёт за месяц Январь.** + +Пример консольного вывода: ``` ✅ Total issues: 7 [2026-01-01--2026-01-31] ╒════════════╤═══════════╤══════════════════════════════════════╤═══════════╤════════════╕ @@ -129,6 +155,6 @@ isort . --- > 🔒 **Важно**: -> - Никогда не коммитьте `.env`, пароли или логины. +> - Никогда не коммитьте `.env`, пароли или логины. > - Файл `.gitignore` уже исключает все чувствительные артефакты. > - Инструмент работает только в режиме **чтения** — он не может изменять данные в Redmine.