ГГИС Паноптикум

Скрипты для упрощения жизни при работе с Kaiten, Gitlab и пр.

Cодержание

Установка зависимостей
Использование skird.py
Использование skird_cmd.py
Использование task_manager.py
- Изменение конфигурации
Использование time_management.py
Пожелания и предложения

Установка зависимостей

Python3 предуставновлен на Ubuntu, но если что

sudo apt-get update
sudo apt-get install python3.6 python3-pip

Необходимо поставить расширение для стандатрного модуля по работе с датой и временем:

pip3 install python-dateutil

Также стоит поставить питону модуль requests, shutil:

sudo apt -y install python3-pip
pip3 install requests
pip3 install shutil

Для использования skird_cmp.py и task_manager.py:

pip3 install argparse
pip3 install click

Использование skird.py

Скрипт создает и оформляет карточки по корпоративному стандарту

Поместить номера сторей в текстовый файл data/tasks.txt (или поменяйте путь в скрипте). На каждой новой строчке - через Tab описание того, что вы нужно сделать

42.0
   Страдать фигней
   Рефакторинг
   Связь с front-end

Добавить файл env/env.json

{
 "kaiten_host": "https://kaiten.iccdev.ru", 
 "kaiten_token": "ваш-токен"
}

Запустить скрипт:

python3 skird.py

??????
Profit. Ваши задачи конвертируются в задачи delivery в бэклоге спринта с нужными:
- названием (включает id карточки as well)
- меткой "ГГИС"
- типом
- пользователем(вы) в роли "ответственного"
- Ролью C++

Использование skird_cmd.py

Новый skird_cmd.py аналогичен skird.py, но имеет интерфейс командной строки и подразумеваеет использование без правки исходного кода. Результат вызова skird_cmd.py без аргументов аналогичен вызову skird.py. Для получения справки вызовите:

./skird_cmd.py -h

Помимо этого skird_cmd.py может работать со списком задач в виде json-документа (формат определяется автоматически при расширении файла *.json):

./skird_cmd.py -p "data/tasks.json"

Формат входного json-файла следующий (для понимания поля "config" изучите соответствующее примечание):

{
  "BUG": {
    "81.23465": [
      {
        "config": "delivery", //можно опустить, используется "delivery" по-умолчанию
        "name": "Починить всё это",
        "size": 16 //(время в часах) можно опустить, используется занчение из выбранной конфигурации
      }
    ]
  },
  "US-EN": {
    "49.9": [
      {
        "config": "delivery",
        "name": "Что-то там интересное делать",
      }
    ],
    "94.3": [
      {
        "config": "discovery",
        "name": "Декомпозиция задач по адаптации алгоритмов буфера обмена и сессий",
        "size": 4
      },
      {
        "config": "delivery",
        "name": "Реализация всего этого",
        "size": 16
      }
    ]
  }
}

Использование task_manager.py

Скрипт task_manager.py призван помочь создать список задач в виде json-формата в автоматическом режиме. Выполните и следуйте вопросам из консоли:

./task_manager.py

Результом исполнения скрипта можно считать файл data/tasks.json, который позже можно поправить вручную или же перед непосредственным ответом на вопрос скрипта "Запустить скрипт создания новых карточек с Вашей конфигурацией?".

Изменение конфигурации

Поскольку теперь нам нужно заводить карточки разных типов, были добавлены конфигурационные файлы следующей структуры:

{
    "board_id": 192,
    "column_id": 776,
    "lane_id": 1275,
    "size_text": "16 ч",
    "type_id": 6,
    
    "properties": { 
        "id_19": "1"
    }
}

board_id - ID доски, на которой нужно создать карточку
column_id - ID колонки
lane_id - Даже не спрашивайте - не помню
size_text - Длительность с единицами измерения
type_id - Тип карточки, очередное магическое число. 11 - Delivery, 6 - Discovery.
properties.id_19 - Роль. "1" - С++. Остальные не знаю, реверсите через запросы сами.

Файл с конфигурацией должен находиться в env/skird_config/.
Чтобы поменять конфиг, замените значение переменной в skird.py на имя вашей конфигурации:

   config_name = 'delivery'

Использование time_management.py

Скрипт автоматически списывает одинаковое время в административную карточку в течение указанного времени

Заполнить под свою карточку файл с настройками env/auto_time_log.json

{
    "start_date": "2024-04-01",
    "days_count": 3,
    "time_spent": 20,
    "role_id": 3,
    "card_id": 24411
}

start_date - Дата начала списаний YYYY-MM-DD
days_count - Количество дней в течение которых списывать, включая выходные. В сами выходные время списано не будет, просто оффсет по дням так работает
time_spent - Время списаний в минутах
role_id - Идентификатор роли, 3 - разработчик, остальные потом пронумерую
card_id - ID карточки, в которую списать время. В данном случае - это дейлики

Запустить скрипт:

python3 time_management.py

Принять всю ответственность на себя и ввести любой бред, начинающийся на y или Y.
????????
Profit

Пожелания и предложения

Оформляйте пожелания в Issues, отправляйте предложения через Pull requests

Kawaiilodon / ggis-panopticon