-
Notifications
You must be signed in to change notification settings - Fork 0
/
PKG-INFO
319 lines (231 loc) · 14 KB
/
PKG-INFO
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
Metadata-Version: 2.1
Name: efb-wechat-slave
Version: 2.0.2
Summary: WeChat Slave Channel for EH Forwarder Bot, based on WeChat Web API.
Home-page: https://ews.1a23.studio
Author: Eana Hufwe
Author-email: ilove@1a23.com
License: AGPLv3+
Description: EFB WeChat Slave Channel：EFB 微信从端 (EWS)
============================================
.. image:: https://img.shields.io/pypi/v/efb-wechat-slave.svg
:alt: PyPI 发布
:target: https://pypi.org/project/efb-wechat-slave/
.. image:: https://github.com/blueset/efb-wechat-slave/workflows/Tests/badge.svg
:alt: 测试状态
:target: https://github.com/blueset/efb-wechat-slave/actions
.. image:: https://pepy.tech/badge/efb-wechat-slave/month
:alt: 每月下载量
:target: https://pepy.tech/project/efb-wechat-slave
.. image:: https://d322cqt584bo4o.cloudfront.net/ehforwarderbot/localized.svg
:alt: Translate this project
:target: https://crowdin.com/project/ehforwarderbot/
.. image:: https://github.com/blueset/efb-wechat-slave/raw/master/banner.png
:alt: 头图
.. image:: https://i.imgur.com/dCZfh14.png
:alt: This project proudly supports #SayNoToWeChat campaign.
`README in other languages`_.
.. TRANSLATORS: change the URL on previous line as "." (without quotations).
.. _README in other languages: ./readme_translations
**Channel ID**: ``blueset.wechat``
EWS 是兼容 EH Forwarder Bot 的微信从端，基于逆向工程的微信网页版、\
修改版 ``wxpy``\ 和 \ ``ItChat``\ 。
本项目的部分代码修改自 `youfou/wxpy`_\ 、\ `littlecodersh/ItChat`_\ 。
.. _youfou/wxpy: https://github.com/youfou/wxpy
.. _littlecodersh/ItChat: https://github.com/littlecodersh/ItChat/
使用前须知
----------
自 2017 年中旬以来，陆续有用户报告其微信网页版登录被腾讯封禁。\
表现为用任何方式登录微信网页版提示「当前登录环境异常。为了你的账号安全，\
暂时不能登录 Web 微信。你可以通过手机客户端或 Windows 微信登录」\
或类似的提示。大部分用户会在封禁后一天到三个月内解封，不同用户的解封耗时不同。\
据观测，仅有约不足一成的用户在使用过程中被封禁。该封禁不影响其他客户端的登录。\
目前封禁的原因尚不明确。
与此同时，有现象表明 2017 年中旬以来新注册的微信用户不能够使用微信网页版。\
在初次使用之前，请先访问\ `微信网页版`_\ 并确认您可以正常使用此功能。\
若您的账号不能使用该功能，请尝试换用其他账号尝试。
如果你对网页版登录有要求的话，请慎用此信道。详细的相关信息请参见 `issue #7`_\ 。
.. _微信网页版: https://web.wechat.com/
.. _issue #7: https://github.com/blueset/efb-wechat-slave/issues/7
软件依赖
--------
- Python >= 3.6
- EH Forwarder Bot >= 2.0.0
- ffmpeg
- libmagic
- pillow
安装与启用
----------
1. 安装如上所要求的二进制依赖
2. 安装
.. code:: shell
pip3 install efb-wechat-slave
3. 使用 \ *EFB 配置向导*\ ，或在当前配置档案（Profile）目录的 \ ``config.yaml``\ 文件中启用 EWS。
当前配置文件夹的位置会根据用户的设定而改变。
**(EFB 2 中，默认的配置档案目录位于**
``~/.ehforwarderbot/profiles/default``\ **)**
其他的安装方式
~~~~~~~~~~~~~~
EWS 同时存在由社区提供的其他安装方式，包括：
- 由 KeLiu_ 维护的 `AUR 软件包`_\ （``python-efb-wechat-slave-git``）。
- 其他\ `安装脚本或 Docker 等容器`_\ 。
.. _KeLiu: https://github.com/specter119
.. _AUR 软件包: https://aur.archlinux.org/packages/python-efb-wechat-slave-git
.. _安装脚本或 Docker 等容器: https://efb-modules.1a23.studio#scripts-and-containers-eg-docker
可选的配置文件
--------------
EWS 支持使用可选的配置文件来启用实验功能。配置文件存储于
``<当前配置文件夹>/blueset.wechat/config.yaml``\ 。
配置文件例
~~~~~~~~~~
.. code:: yaml
# 实验功能
# 使用本段来调整实验功能的设置。请注意实验功能随时可能变更或失效。
# 详细说明见下文。
flags:
option_one: 10
option_two: false
option_three: "foobar"
常见问题
--------
- **如何切换已登录的微信账号？**
请登出当前的账号，并使用其他的微信手机登录。
- **如何登录两个微信账号？**
请在 EFB 配置文件中指定不同的实例 ID。
- **EWS 稳定吗？**
EWS 依赖于上游项目
`ItChat <https://github.com/littlecodersh/ItChat>`__
以及微信网页版的协议。根据 `ItChat
FAQ <https://itchat.readthedocs.io/zh/latest/FAQ/>`__
的说明，在满足以下情况的条件下，微信登录能够保持数个月稳定登录:
- 服务器有稳定的网络连接，并且
- **保持手机客户端长期在线。**
已知问题
--------
- 就于微信网页版的工作原理，目前对于没有名称的会话、以及重名的会话支持较差，\
可能会有消息传递错误等问题。
- 同理，部分情况下变更名称的会话会被视为全新的会话，而「旧会话」随即消失。
- 仅支持微信网页版所支持的功能以及消息类型，即
- 没有朋友圈
- 没有红包
- 不能发语音
- 不能发位置
- ……等等诸如此类
- 部分文件、图片、表情等多媒体文件会被网页版微信截断，即收不到任何数据，
尤以表情为甚。因此造成的偶发现象，会提醒用户使用移动客户端查看。
实验功能
--------
以下的实验功能可能不稳定，并可能随时更改、删除。使用时请注意。
- ``refresh_friends`` *(bool)* [默认值: ``false``]
每当请求会话列表时，强制刷新会话列表。
- ``first_link_only`` *(bool)* [默认值: ``false``]
在收到多链接消息时，仅发送第一条链接。默认多链接会发送多条消息。
- ``max_quote_length`` *(int)* [默认值: ``-1``]
引用消息中引文的长度限制。设置为 0 关闭引文功能。设置为 -1
则对引文长度不做限制。
- ``qr_reload`` *(str)* [默认值: ``"master_qr_code"``]
重新登录时使用的登录方式：
选项:
- ``"console_qr_code"``:
将二维码和提示输出到系统标准输出（\ ``stdout``\ ）。
- ``"master_qr_code"``: 将二维码和提示发送到主端。 **注意**\
登录时二维码会频繁刷新，请注意二维码可能会导致刷屏。
- ``on_log_out`` *(str)* [默认值: ``"command"``]
微信服务器将用户登出时的操作。
选项:
- ``"idle"``: 仅通知用户。
- ``"reauth"``: 通知用户，并立即开始重新登录。
- ``"command"``: 通知用户，并等待用户启动重新登录过程。
- ``imgcat_qr`` *(bool)* [默认值: ``false``]
使用 `iTerm2
图像协议 <https://www.iterm2.com/documentation-images.html>`__
显示二维码。本功能只适用于 iTerm2 用户。
- ``delete_on_edit`` *(bool)* [默认值: ``false``]
以撤回并重新发送的方式代替编辑消息。默认禁止编辑消息。
- ``app_shared_link_mode`` *(str)* [默认值：``"ignore"``]
在收到第三方合作应用分享给微信的链接时，其附带的预览图以何种形式发送。
- ``"ignore"``\ ：忽略附带的缩略图
- ``"upload"``\ ：将缩略图上传到公开图床（\ https://sm.ms\ ），\
并在日志中输出图片的删除链接。
- ``"image"``\ ：将消息以图片形式发送（不推荐）
- ``puid_logs`` *(str)* [默认值：``null``]
输出 PUID 相关日志到指定日志路径。请使用绝对路径。PUID 日志可能会根据\
会话数量和消息吞吐量而占用大量存储空间。
- ``send_stickers_and_gif_as_jpeg`` *(bool)* [默认值: ``false``]
以 JPEG 图片方式发送自定义表情和 GIF，用于临时绕过微信网页版的自定义表情限制。\
详见 `#48`_\ 。
.. _#48: https://ews.1a23.studio/issues/48
- ``system_chats_to_include`` *(list of str)* [默认值: ``[filehelper]``]
在默认会话列表中显示的特殊系统会话。其内容仅能为 ``filehelper``\
（文件传输助手）、\ ``fmessage``\ （朋友推荐消息）、\ ``newsapp``\
（腾讯新闻）、\ ``weixin``\ （微信团队）其中零到四个选项。
- ``user_agent`` *(str)* [默认值: ``null``]
指定登陆网页版微信时所使用的「用户代理」（user agent）字符串。\
不指定则使用 itchat 提供的默认值。
- ``text_post_processing`` *(bool)* [默认值: ``true``]
调整是否在从微信收到消息后对消息文本进行后处理步骤。
``vendor_specific``
-------------------
EWS 的 \ ``Chat``\ 提供了以下的 \ ``vendor_specific``\ 项目：
- ``is_mp`` *(bool)*
该会话是否为公众号。
- ``is_contact`` *(bool)*
不明。提取自 API。
- ``is_blacklist_contact`` *(bool)*
该用户是否被加入黑名单。
- ``is_conversation_contact`` *(bool)*
不明。提取自 API。
- ``is_room_contact_del`` *(bool)*
不明。提取自 API。
- ``is_room_owner`` *(bool)*
该用户是否为群组创建者。
- ``is_brand_contact`` *(bool)*
不明。提取自 API。
- ``is_sp_contact`` *(bool)*
不明。提取自 API。
- ``is_shield_user`` *(bool)*
不明。提取自 API。
- ``is_muted`` *(bool)*
该会话是否在微信中开启免打扰。
- ``is_top`` *(bool)*
该会话是否在微信中被置顶。
- ``has_photo_album`` *(bool)*
不明。提取自 API。
开源许可
--------
EWS 使用了 \ `GNU Affero 通用公共许可协议 3.0`_\ （GNU Affero General Public
License 3.0）或更新版本作为其开源许可::
EFB 微信从端：一个适用于 EH Forwarder Bot 的从端
Copyright (C) 2016 - 2020 Eana Hufwe 和 EFB 微信从端贡献者
保留所有权利。
此程序是一个自由软件；您可以在遵守由自由软件基金会发布的第三版或更新
版本的 GNU Affero 通用公共许可协议的情况下重新分发并和/或修改软件。
我们本着可为人所用的意愿分发此软件，但并不提供任何保证；甚至没有商业
性的或对特定目的适用性的暗指。更多细节请参看 GNU Affero 通用公共许可
协议。
您应该已经随收到一份 GNU Affero 通用公共许可协议；如果没有，请查阅
<http://www.gnu.org/licenses/>。
.. _GNU Affero 通用公共许可协议 3.0: https://www.gnu.org/licenses/agpl-3.0.txt
翻译界面
--------
EWS 启用了社区支持的本地化翻译。您可以将语言环境变量 (``LANGUAGE``,
``LC_ALL``, ``LC_MESSAGES`` 或 ``LANG``) 设为一种\ `已支持的语言`_\ 。
同时，您也可以在我们的 `Crowdin 项目`_\ 里面将 EWS 翻译为您的语言。
.. _已支持的语言: https://crowdin.com/project/ehforwarderbot/
.. _Crowdin 项目: https://crowdin.com/project/ehforwarderbot/
.. note::
如果您是从源码安装的 EWS，您需要在安装前事先编译翻译文本目录（\ ``.mo``\ ），\
才可启用界面翻译。
Keywords: ehforwarderbot,EH Forwarder Bot,EH Forwarder Bot Slave Channel,wechat,weixin,chatbot
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Communications :: Chat
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Provides-Extra: tests