¶ Ключевые показатели эффективности проектных руководителей
Данная программа позволяет создать таблицу с ключевыми показателями эффективности (KPI) проектных руководителей.
Репозиторий программы
"KPI проектных руководителей" - таблица.
¶ Основные библиотеки, сервисы и технологии
- Python 3.11 - https://www.python.org/downloads/release/python-3110/.
- Docker - https://www.docker.com/.
- pydantic - https://pypi.org/project/pydantic/.
- mongoengine - http://mongoengine.org/.
- footprint-mongoengine - https://footprint.auditory.ru/pypi/.
- Cabinet API - https://devcabinet.miem.vmnet.top/api/doc.
- API Google Sheets - https://developers.google.com/sheets/api/reference/rest.
- Wekan REST API - https://wekan.github.io/api/v2.71/.
¶ API Routes
| Метод | Путь | Описание |
|---|---|---|
| GET | https://wekan.miem.hse.ru/api/users/{user_id}/boards |
Получение всех досок |
| GET | https://cabinet.miem.hse.ru/api/feedback/{projectId} |
Получение информации об отчетности в циклах |
¶ Предварительная настройка
¶ Настройка Google Sheets
Для того чтобы начать пользоваться гугл таблицей, Вам необходимо получить файл с реквизитами для создания и модерации будущей таблицы - config.json.
Его необходимо получить, совершив следующие шаги по ссылке:
- Создать проект, подключив к нему
Google Drive ApiиGoogle Sheets Api. - Создать сервисный аккаунт.
- Скачать файл с реквизитами и перенести в директорию с проектом, переименовав его в
config.json.
¶ Настройка Виртуальной Среды
Для более управляемого поведения требуется использовать виртуальную среду. Можно использовать любой доступный вариант, но рекомендуется venv. Виртуальная среда избавит от проблем, связанных с изменениями в глобальном интерпретаторе.
¶ Зависимости
Для того чтобы установить адаптер, вам необходимо клонировать данный репозиторий, используя данную команду:
https://git.miem.hse.ru/394/scripts/headleader-kpi.git
Для корректной работы Вам необходимо установить все зависимости, указанные в requirements.txt, используя команду:
pip install --extra-index-url https://footprint.auditory.ru/pypi/simple -r requirements.txt
¶ Структура программы
script \
cabinet \
api.py - модуль для работы с API Cabinet и Wekan
responses.py - модуль для создания pydantic моделей
config.py - модуль для работы с конфигурацией программы
database.py - модуль для обращения к модулям пакета footprint_mongoengine
kpi.py - модуль для создания таблицы
utils.py - дополнительные функции и константы
main.py - основной скрипт программы
requirements.txt - список зависимостей программы
README.md - описание
¶ Основные функции
Все функции, реализующие таблицу, находятся в файле kpi.py
clear_sheet- удаляется все данные с текущего листа.create_kpi- обновляет информацию на листеKPI.get_head_kpi- получает количество всех студентов для конкретной образовательной программы.find_sheet_id- выводит id необходимого листа текущей таблицы.set_column_size- устанавливает необходимые размеры колонок таблицы.
¶ Метрики
Для получения ключевых показателей эффективности было решено использовать следующие метрики.
¶ Метрика по выполненным задачам
Источником данных для данной метрики является список выполненных задач в циклах в статистике кабинета.
¶ Метрика по заполненным планам и результатам в циклах
Источником данных для данной метрики являются планы и результаты в отчетности кабинета.
¶ Формат данных таблицы
| Руководитель проекта | Почта | ID проекта | Название проекта | tasks_kpi6 | tasks_kpi12 | plan_results_kpi6 | plan_results_kpi12 | Ссылка на проект |
|---|---|---|---|---|---|---|---|---|
| ФИО | соответствующая почта | № проекта | соответствующее название | kpi по зачтенным задачам для 6 месяцев | kpi по зачтенным задачам для 12 месяцев | kpi по зачтенным циклам для 6 месяцев | kpi по зачтенным циклам для 12 месяцев | соответствующая ссылка |