Files
redmine_tracker/README.MD

82 lines
3.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# [Redmine Tracker](https://git.sbps.ru/e.vlasov/redmine_tracker)
## Описание:
Скрипт для автоматического перенесения всех активностей с Clockify в Redmine.
Сначала получаем все активности через Clockify API, затем заносим их через Redmine API.
## Переменные
|Clockify|Redmine|Пример/Уточнение|
|--------|-------|------|
|Описание задачи (Description)|Комментарий|Уточнение у аналитика|
|Теги (Tags)|<Задача> - <Название задачи>|28882 - Прочие активности по Ветро|
|Трекать/Не трекать (Billable/Non-billable)|<Занесена в Redmine или нет>|Если выбрано, то активность будет перенесена
<br>
Тег обязательно должен содержать номер задачи (5 цифр) в начале.<br>
28882 - Прочие активности<br>
28882<br>
28882 Прочие активности<br>
### Запуск:
Клонируйте [репозиторий](https://git.sbps.ru/e.vlasov/redmine_tracker) и перейдите в него в командной строке:
```bash
git clone ssh://git@git.sbps.ru:4567/e.vlasov/redmine_tracker.git
cd redmine_tracker
```
Создайте виртуальное окружение и активируйте его
```bash
python -m venv venv
```
Windows
```bash
venv/Scripts/activate
```
Linux/Ubuntu/MacOS
```bash
source venv/bin/activate
```
Обновите pip:
```bash
python -m pip install --upgrade pip
```
Установите зависимости:
```bash
pip install -r requirements.txt
```
Создайте файл .env и добавьте в него переменные:
```bash
touch .env
```
```env
*REDMINE_TOKEN=<api_ключ_redmine>
*CLOCKIFY_TOKEN=<api_ключ_clockify>
?USER_ID=<user_id_clockify>
?WORKSPACE_ID=<workspace_id_clockify>
```
\* - Обязательные.<br>
? - Опциональные. Могут быть пустыми, но не должны отсутствовать вовсе.
## Запуск.
```
python track.py
```
## Аргументы запуска
| Аргумент | Описание | Пример использования |
|-------------------|--------------------------------------------------------------|--------------------------------------|
| `-h [--help]` | Показать справку | `python track.py --help` |
| `-s [--start]` | Дата начала парсинга активностей в формате гггг-мм-дд | `python track.py --start 2025-05-19` |
| `-e [--end]` | Дата окончания парсинга активностей в формате гггг-мм-дд | `python track.py -e 2025-05-19` |
| `-p [--page-size]`| Количество задач для вывода. Выведет последние n записей | `python track.py --page-size 15` |
| `-d [--debug]` | Режим отладки. Не загружает трудочасы в Redmine | `python track.py -d` |
| `-i [--init-db]` | Режим инициализации бд. | `python track.py -init-db` |
| | Подгружает с серверов теги, виды деятельности и проекты Ветро| |
[Власов Эдуард](https://github.com/QuickLike)