Update README.md

This commit is contained in:
Кокос Артем Николаевич
2026-01-20 12:54:29 +07:00
parent 59d819fdc1
commit dde66ec709

View File

@@ -13,6 +13,7 @@
- Группировка задач по проекту и версии
- Перевод статусов на русский язык
- Простой CLI с понятными аргументами
- Поддержка настройки диапазона дат по умолчанию через `.env`
---
@@ -48,7 +49,7 @@ cat /etc/ssl/certs/ca-certificates.crt >> $(python -m certifi)
> ✅ Это безопасно: вы просто добавляете доверенные системные сертификаты к Python.
> Не используйте `verify=False` — это создаёт уязвимость.
### 4. Настройте учётные данные
### 4. Настройте учётные данные и (опционально) даты
Создайте файл `.env` в корне проекта (**никогда не коммитьте его!**):
@@ -56,6 +57,10 @@ cat /etc/ssl/certs/ca-certificates.crt >> $(python -m certifi)
REDMINE_URL=https://red.eltex.loc/
REDMINE_USER=ваш.логин
REDMINE_PASSWORD=ваш_пароль
# Опционально: диапазон дат по умолчанию
DEFAULT_FROM_DATE=2026-01-01
DEFAULT_TO_DATE=2026-01-31
```
Альтернатива — задать переменные вручную:
@@ -64,9 +69,12 @@ REDMINE_PASSWORD=ваш_пароль
export REDMINE_URL=https://red.eltex.loc/
export REDMINE_USER=ваш.логин
export REDMINE_PASSWORD=...
export DEFAULT_FROM_DATE=2026-01-01
export DEFAULT_TO_DATE=2026-01-31
```
> 🔐 Рекомендуется использовать аккаунт с минимальными правами (только чтение time entries и задач).
> 💡 Если `DEFAULT_FROM_DATE` и `DEFAULT_TO_DATE` не заданы, используется встроенный диапазон: `2025-12-19--2026-01-31`.
---
@@ -81,11 +89,11 @@ source .venv/bin/activate
Затем:
```bash
# Отчёт за период по умолчанию
# Отчёт за период по умолчанию (из .env или встроенный)
redmine-reporter
# Отчёт за произвольный период
redmine-reporter --date 2026-01-01--2026-01-31
# Отчёт за произвольный период (переопределяет .env)
redmine-reporter --date 2026-02-01--2026-02-28
# Компактный вывод (удобно копировать в письмо)
redmine-reporter --compact