chatroom syncer

Sincronizador de salas de chat

Chatroom-Syncer es un proyecto para sincronizar IM Chat Room con el dominio público como IRC en los viejos tiempos, de modo que otros puedan descubrir, aprender y hacer referencia a la información, el contexto y el historial de la comunicación, en cualquier momento y en cualquier momento.

demostración-chat-sync.mp4

Fregaderos compatibles

• Flojo
• GitHub
• IRC
• Telegrama
• Discordia

Componentes y flujo

Componentes	Imágenes de Docker	Comentarios de imagen
wechaty-gateway		"wechaty": "1.20.2" "wechaty-puppet-wechat": "1.18.4"
chatroom-syncer		- etiqueta: dev es el encabezado de la rama principal - latest es la última versión de

Hay dos procesos en el sistema:

• Chatroom Syncer, base de código actual en Python como WeChaty Client y el bot
• WeChaty Gateway, que aprovecha Wechaty con UOS Wechat Client (también denominado títere) para ser llamado por Chatroom Syncer debido a que WebChaty no es una biblioteca nativa de Python, y Wechaty Gateway es un servidor gRPC para manipular y observar WeChat, el títere. .

Por lo tanto, debemos iniciar WeChaty Gateway antes que Chatroom Syncer.

 ┌────────────────────────────┐        ┌────────┐     ┌────────┐
│                            │        │ Sink   │     │        │
│ Chatroom Syncer            │        │        │     │        │
│                            │        │ GitHub │     │        │
│ onMessage()                ├────────▶ Slack ─ ─ ─ ─▶ Linen* │
│   self.use(***SinkPlugin())│        │        │     │        │
│                            │        │        │     │        │
└──────────────▲─────────────┘        │        │     │        │
               │                      └────────┘     └────────┘
             gRPC
               │
┌──────────────▼──────────────┐
│                             │
│  Wechaty Gateway            │
│                             │
│                             │
│┌────────────────────────┐   │
││ Wechaty UOS puppet     │   │
│└────────────────────────┘   │
└─────────────────────────────┘

# * Linen.dev is a Open Source project and a SaaS/Cloud service to help sync slack/discord to a searchable and shareable public domain.

Correr

Antes de ejecutar, necesitamos seguir los requisitos previos:

• Configure los nombres de los grupos de WeChat y la información del receptor en config.yaml ; deberían existir tanto en WeChat como en el receptor.
• Configure el token de API de Sink (token de API de Slack, token de GitHub, etc.) en .env .

Ejecutar con Docker

Ejecútelo en segundo plano:

cp config-example.yaml config.yaml
cp env-example .env
docker-compose up -d

Verifique que ambos contenedores estén arriba:

docker-compose ps

En caso de que haya algún contenedor Exit 0 , intente nuevamente iniciar:

docker-compose up -d

Escanea el código QR con tu aplicación WeChat y ¡listo!

docker logs chatroom-syncer_chatroom-syncer_1 2> /dev/null | grep -v Wechaty

Basta:

docker-compose down

Ejecutar desde el host

Ejecute primero la puerta de enlace Webchaty:

 export token= " iwonttellyou "
docker run -d 
    --name=wechaty-gateway 
    --net=bridge 
    -p 9009:9009 
    -e WECHATY_PUPPET_SERVICE_TOKEN= " $token " 
    --restart=unless-stopped weygu/wechaty-gateway:latest

Ejecute Chatroom-Syncer:

 # install it
python3 -m pip install chatroom-syncer
# create config.yaml and change it
cp config-example.yaml config.yaml

# put tokens for sink according to your config.yaml
# i.e. if both slack and github discussion sinks were enabled
# we need token to send message to slack and github discussion
# as follow:
export SLACK_BOT_TOKEN= " xoxb-1234567890-1234567890-1234567890-1234567890 "
export GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxxx

# run it
python3 -m chatroom_syncer

Configuración

WeChat

Copie config-example.yaml a config.yaml

cp config-example.yaml config.yaml

Y complete los siguientes campos en la tabla:

Campo	Descripción
enable_slack	Interruptor de fregadero flojo
group_channel_mapping	Asignación del nombre del grupo WeChat al nombre del canal Slack
enable_avatar	Cambiar para generar un avatar basado en emoji para Slack Sink
enable_github_discussion	Cambio del fregadero de discusión de Github
group_github_discussion_mapping	Asignación del nombre del grupo WeChat a la discusión: propietario/repositorio/categoría

Contribuir

Construir desde el host

git clone https://github.com/wey-gu/chatroom-syncer && cd chatroom-syncer
# install pdm
curl -sSL https://raw.githubusercontent.com/pdm-project/pdm/main/install-pdm.py | python3 -
# install chatroom-syncer
pdm install

Si se actualizan las dependencias, ejecute pdm sync para actualizar el manifiesto de bloqueo.

pdm sync

Construir desde la ventana acoplable

docker-compose -f docker-compose.dev.yaml build
docker-compose -f docker-compose.dev.yaml up -d

# get QR code to scan
docker logs chatroom-syncer_chatroom-syncer_1 2> /dev/null | grep -v Wechaty

# watch logs of the chatroom syncer
docker logs chatroom-syncer_chatroom-syncer_1 --follow

# stop the chatroom syncer and remove the container
docker-compose -f docker-compose.dev.yaml down

pelusa

 # install pre-commit
pip install pre-commit

# run pre-commit
pre-commit run --all-files