Skip to content
GitLab

Руководство разработчика · Changes

Page history
format files done authored by Григорий Хромов's avatar Григорий Хромов
Hide whitespace changes
Inline Side-by-side
Руководство-разработчика.md
View page @ c440b885
......@@ -39,18 +39,24 @@
6. [`Pipfile.lock`](https://git.miem.hse.ru/240/competence-search/-/tree/master/cabinet/Pipfile.lock): файл с полным списком необходимых библиотек и их зависимостей, а также версий всех библиотек
7. [`logging_debug.conf`](https://git.miem.hse.ru/240/competence-search/-/tree/master/cabinet/logging_debug.conf): файл с настройкой логирования для режима `DEBUG`
8. [`logging_default.conf`](https://git.miem.hse.ru/240/competence-search/-/tree/master/cabinet/logging_default.conf): файл с настройкой логирования для режима `DEFAULT`
2. [`chat_bot`](https://git.miem.hse.ru/240/competence-search/-/tree/master/chat_bot): чат-бот
1. [`src`](https://git.miem.hse.ru/240/competence-search/-/blob/master/chat_bot/src)
1. [`src`](https://git.miem.hse.ru/240/competence-search/-/blob/master/chat_bot/src): исходные программные файлы
1. [`main.py`](https://git.miem.hse.ru/240/competence-search/-/blob/master/chat_bot/src/main.py): описание класса – чат-бота
2. [`Dockerfile`](https://git.miem.hse.ru/240/competence-search/-/tree/master/chat_bot/Dockerfile): файл с `Docker` образом микросервиса
3. [`Pipfile`](https://git.miem.hse.ru/240/competence-search/-/tree/master/chat_bot/Pipfile): файл со списком всех необходимых библиотек-зависимостей
4. [`Pipfile.lock`](https://git.miem.hse.ru/240/competence-search/-/tree/master/chat_bot/Pipfile.lock): файл с полным списком необходимых библиотек и их зависимостей, а также версий всех библиотек
5. [`logging_debug.conf`](https://git.miem.hse.ru/240/competence-search/-/tree/master/chat_bot/logging_debug.conf): файл с настройкой логирования для режима `DEBUG`
6. [`logging_default.conf`](https://git.miem.hse.ru/240/competence-search/-/tree/master/chat_bot/logging_default.conf): файл с настройкой логирования для режима `DEFAULT`
3. [`colab_notebooks`](https://git.miem.hse.ru/240/competence-search/-/tree/master/colab_notebooks): jupyter-ноутбуки с тестированием работы моделей
1. [`cabinet.ipynb`](https://git.miem.hse.ru/240/competence-search/-/blob/master/colab_notebooks/cabinet.ipynb): тест модели **Личный кабинет МИЭМ**
4. [`competence_search`](https://git.miem.hse.ru/240/competence-search/-/tree/master/competence_search): микросервис **Competence Search**
1. [`src`](https://git.miem.hse.ru/240/competence-search/-/blob/master/competence_search/src)
1. [`src`](https://git.miem.hse.ru/240/competence-search/-/blob/master/competence_search/src): исходные программные файлы
1. [`main.py`](https://git.miem.hse.ru/240/competence-search/-/blob/master/competence_search/src/main.py): отправная точка, обработчики для всех `REST/HTTP` методов
2. [`services.py`](https://git.miem.hse.ru/240/competence-search/-/blob/master/competence_search/src/services.py): получение данных из всех _микросервисов-обработчиков_, вычисление общей оценки релевантности
2. [`Dockerfile`](https://git.miem.hse.ru/240/competence-search/-/tree/master/competence_search/Dockerfile): файл с `Docker` образом микросервиса
......@@ -58,20 +64,39 @@
4. [`Pipfile.lock`](https://git.miem.hse.ru/240/competence-search/-/tree/master/competence_search/Pipfile.lock): файл с полным списком необходимых библиотек и их зависимостей, а также версий всех библиотек
5. [`logging_debug.conf`](https://git.miem.hse.ru/240/competence-search/-/tree/master/competence_search/logging_debug.conf): файл с настройкой логирования для режима `DEBUG`
6. [`logging_default.conf`](https://git.miem.hse.ru/240/competence-search/-/tree/master/competence_search/logging_default.conf): файл с настройкой логирования для режима `DEFAULT`
5. [`credentials`](https://git.miem.hse.ru/240/competence-search/-/tree/master/credentials): файлы с учетными данными
1. [`credentials.json.example`](https://git.miem.hse.ru/240/competence-search/-/tree/master/credentials/credentials.json.example): пример файла с учетными данными для микросервиса **Gtable**
2. [`zulip_admin.txt.example`](https://git.miem.hse.ru/240/competence-search/-/tree/master/credentials/zulip_admin.txt.example): пример файла с учетными данными администратора **Zulip** (для работы с `API` **Zulip**)
3. [`credentials.json.example`](https://git.miem.hse.ru/240/competence-search/-/tree/master/credentials/credentials.json.example): пример файла с учетными данными для микросервиса **Gtable**
4. [`credentials.json.example`](https://git.miem.hse.ru/240/competence-search/-/tree/master/credentials/credentials.json.example): пример файла с учетными данными для микросервиса **Gtable**
6. [**gtable**](https://git.miem.hse.ru/240/competence-search/-/tree/master/gtable)
7. [**lib**](https://git.miem.hse.ru/240/competence-search/-/tree/master/lib): модели и ...
1. [*cabinet_data.py*](https://git.miem.hse.ru/240/competence-search/-/tree/master/cabinet_data.py): --
2. [*sbertop2vec.py*](https://git.miem.hse.ru/240/competence-search/-/tree/master/sbertop2vec.py): описание класса – тематической модели для сервисов Zulip и Wiki
3. [*smartsearch.py*](https://git.miem.hse.ru/240/competence-search/-/tree/master/smartsearch.py): описание класса – модели для "Личного кабинета МИЭМ"
4. [*wiki_data.py*](https://git.miem.hse.ru/240/competence-search/-/tree/master/wiki_data.py): --
5. [*zulip_data.py*](https://git.miem.hse.ru/240/competence-search/-/tree/master/zulip_data.py): --
3. [`zulip_bot.txt.example`](https://git.miem.hse.ru/240/competence-search/-/tree/master/credentials/zulip_bot.txt.example): пример файла с учетными данными для бота **Поисковик компетенций**
4. [`zulip_bot_dev.json.example`](https://git.miem.hse.ru/240/competence-search/-/tree/master/credentials/zulip_bot_dev.txt.example): пример файла с учетными данными для бота **test_bot_240**
6. [`gtable`](https://git.miem.hse.ru/240/competence-search/-/tree/master/gtable): микросервис **Gtable**
1. [`src`](https://git.miem.hse.ru/240/competence-search/-/blob/master/gtable/src): исходные программные файлы
1. [`main.py`](https://git.miem.hse.ru/240/competence-search/-/blob/master/gtable/src/main.py): отправная точка, обработчики для всех `REST/HTTP` методов
2. [`gsheets`](https://git.miem.hse.ru/240/competence-search/-/blob/master/gtable/src/gsheets): директория с файлами для работы с **Google** `API`
1. [`google_sheets_api.py`](https://git.miem.hse.ru/240/competence-search/-/blob/master/gtable/src/gsheets/google_sheets_api.py): класс для работы с Google Таблицами
2. [`google_sheets_data.py`](https://git.miem.hse.ru/240/competence-search/-/blob/master/gtable/src/gsheets/google_sheets_api.py): экзмепляр класса для работы с Google Таблицами, функция для вставки данных в таблицу
2. [`.env`](https://git.miem.hse.ru/240/competence-search/-/tree/master/gtable/.env): файл с `id` таблицы Google
3. [`Dockerfile`](https://git.miem.hse.ru/240/competence-search/-/tree/master/gtable/Dockerfile): файл с `Docker` образом микросервиса
4. [`Pipfile`](https://git.miem.hse.ru/240/competence-search/-/tree/master/gtable/Pipfile): файл со списком всех необходимых библиотек-зависимостей
5. [`Pipfile.lock`](https://git.miem.hse.ru/240/competence-search/-/tree/master/gtable/Pipfile.lock): файл с полным списком необходимых библиотек и их зависимостей, а также версий всех библиотек
6. [`logging_debug.conf`](https://git.miem.hse.ru/240/competence-search/-/tree/master/gtable/logging_debug.conf): файл с настройкой логирования для режима `DEBUG`
7. [`logging_default.conf`](https://git.miem.hse.ru/240/competence-search/-/tree/master/gtable/logging_default.conf): файл с настройкой логирования для режима `DEFAULT`
7. [`lib`](https://git.miem.hse.ru/240/competence-search/-/tree/master/lib): модели и обертки над `API` сервисов
1. [`cabinet_data.py`](https://git.miem.hse.ru/240/competence-search/-/tree/master/cabinet_data.py): функции для работы с `API` **Личного Кабинета МИЭМ**
2. [`sbertop2vec.py`](https://git.miem.hse.ru/240/competence-search/-/tree/master/sbertop2vec.py): описание класса – тематической модели для сервисов **Zulip** и **МИЭМ Wiki**
3. [`smartsearch.py`](https://git.miem.hse.ru/240/competence-search/-/tree/master/smartsearch.py): описание класса – модели для **Личного Кабинета МИЭМ**
4. [`wiki_data.py`](https://git.miem.hse.ru/240/competence-search/-/tree/master/wiki_data.py): функции для работы с `API` **МИЭМ Wiki**
5. [`zulip_data.py`](https://git.miem.hse.ru/240/competence-search/-/tree/master/zulip_data.py): функции для работы с `API` **Zulip**
8. [`logs`](https://git.miem.hse.ru/240/competence-search/-/tree/master/logs): директория с логами от всех микросервисов
9. [`wiki`](https://git.miem.hse.ru/240/competence-search/-/tree/master/wiki): микросервис **Wiki**
1. [`data`](https://git.miem.hse.ru/240/competence-search/-/tree/master/wiki/data): директория с файлами данных из **МИЭМ Wiki** и бинарным файлом модели
2. [`src`](https://git.miem.hse.ru/240/competence-search/-/tree/master/wiki/src): исходные программные файлы
......@@ -91,7 +116,9 @@
6. [`Pipfile.lock`](https://git.miem.hse.ru/240/competence-search/-/tree/master/wiki/Pipfile.lock): файл с полным списком необходимых библиотек и их зависимостей, а также версий всех библиотек
7. [`logging_debug.conf`](https://git.miem.hse.ru/240/competence-search/-/tree/master/wiki/logging_debug.conf): файл с настройкой логирования для режима `DEBUG`
8. [`logging_default.conf`](https://git.miem.hse.ru/240/competence-search/-/tree/master/wiki/logging_default.conf): файл с настройкой логирования для режима `DEFAULT`
10. [**zulip**](https://git.miem.hse.ru/240/competence-search/-/tree/master/zulip): микросервис **Zulip**
10. [`zulip`](https://git.miem.hse.ru/240/competence-search/-/tree/master/zulip): микросервис **Zulip**
1. [`data`](https://git.miem.hse.ru/240/competence-search/-/tree/master/zulip/data): директория с файлами данных из **Zulip** и бинарным файлом модели
2. [`src`](https://git.miem.hse.ru/240/competence-search/-/tree/master/zulip/src): исходные программные файлы
1. [`server`](https://git.miem.hse.ru/240/competence-search/-/tree/master/zulip/src/server): файлы процесса-сервера
......