Это адаптер для сбора информации из Zulip Chat.
Для работы необходимо получить API-ключ. Его можно получить через интерфейс с помощью инструкций.
[
{
"stream_id": "stream_id",
"name": "stream_name",
"description": "stream_description",
"stream_post_policy": "which_users_can_post_messages",
"first_message_id": "id_of_the_first_message"
},
...
]
[
{
"client": "client_of_message_sender",
"content": "message_content_in_html",
"content_type": "text/html",
"mentioned": [
"user_id",
...
],
"sender_slug": "message_sender_slug",
"sender": "sender_id",
"stream": "stream_id",
"subject": "name_of_subject",
"timestamp": "datetime ISO format",
"type": "type_of_the_message"
},
...
]
get_streams
- получает все новые активные каналы из Zulip;get_messages
- получает все новые публичные сообщения из Zulip;Для того чтобы установить адаптер кабинета, Вам необходимо клонировать данный репозиторий, используя данную команду:
git clone --branch yaroslav https://git.miem.hse.ru/394/adapters/zulip.git
Для корректной работы Вам необходимо установить все зависимости, указанные в requirements.txt
, используя команду:
pip install --extra-index-url https://footprint.auditory.ru/pypi/simple -r requirements.txt
Если вы используете docker, в первую очередь Вам необходимо собрать образ, используя команду:
docker build -t zulip .
Для того чтобы запустить скрипт, Вам необходимо создать необходимые переменные окружения.
После Вы можете запустить контейнер, используя команду:
docker run --rm --env-file .env zulip