chatroom syncer

Sincronizador de sala de bate-papo

Chatroom-Syncer é um projeto para sincronizar IM Chat Room com o domínio público como o IRC antigamente, para que as informações, o contexto e o histórico da comunicação possam ser descobertos, aprendidos e referenciados por outros, em qualquer lugar, a qualquer hora.

demo-chat-sync.mp4

Pias Suportadas

• Folga
• GitHub
• IRC
• Telegrama
• Discórdia

Componentes e Fluxo

Componentes	Imagens Docker	Comentários de imagem
wechaty-gateway		"wechaty": "1.20.2" "wechaty-puppet-wechat": "1.18.4"
chatroom-syncer		- tag: dev é o chefe do branch principal - latest é o lançamento mais recente em

Existem dois processos no sistema:

• Chatroom Syncer, base de código atual em Python como o cliente WeChaty e o bot
• WeChaty Gateway, que aproveita o Wechaty com UOS Wechat Client (também chamado de fantoche) para ser chamado pelo Chatroom Syncer devido ao WebChaty não ser uma biblioteca Python nativa, e o Wechaty Gateway é um servidor gRPC para manipular e observar o WeChat o fantoche .

Portanto, precisamos iniciar o WeChaty Gateway antes do 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 executar, precisamos seguir os pré-requisitos:

• Configure os nomes dos grupos WeChat e as informações do Sink em config.yaml , eles devem existir no WeChat e no Sink.
• Configure o token da API do Sink (token da API do Slack, token do GitHub etc.) em .env .

Execute com Docker

Execute-o em segundo plano:

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

Verifique se ambos os contêineres estão ativos:

docker-compose ps

Caso existam contêineres Exit 0 , tente novamente inicializar:

docker-compose up -d

Digitalize o código QR com seu aplicativo WeChat e você estará pronto para começar!

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

Pare com isso:

docker-compose down

Executar do host

Execute o gateway Webchaty primeiro:

 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

Execute o 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

Configuração

WeChat

Copie config-example.yaml para config.yaml

cp config-example.yaml config.yaml

E preencha os seguintes campos da tabela:

Campo	Descrição
enable_slack	Interruptor de pia frouxa
group_channel_mapping	Mapeando o nome do grupo WeChat para o nome do canal do Slack
enable_avatar	Mudar para gerar avatar baseado em emoji para coletor do Slack
enable_github_discussion	Mudança do coletor de discussão do Github
group_github_discussion_mapping	Mapeando o nome do grupo WeChat para discussão:proprietário/repo/categoria

Contribuir

Construir a partir do 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

Se as dependências forem atualizadas, execute pdm sync para atualizar o manifesto de bloqueio.

pdm sync

Construir a partir da janela de encaixe

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

fiapos

 # install pre-commit
pip install pre-commit

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