Package: teelebot
teelebotPython实现的Telegram Bot机器人框架，具有插件系统，插件支持热更新和热装载。________//_______//__//_____//_/__/_\/_\//_\/__\/__\/__///_/__/__//__//_///_///_\__/\___/\___/_/\___/_.___/\____/\__/说明teelebot是Python编写的Telegram Bot框架。teelebot具有插件系统，Bot功能以插件的形式组织，你只需要实现具有特定功能的插件，其余细节交给teelebot框架处理，极大地提高了Bot的开发部署效率。你可以自由地组合插件，来搭建具有特定功能的Bot。插件请前往：官方插件仓库推荐插件：Menu- 自动生成的插件菜单Uptime- 获取Bot运行状态PluginCTL- 插件分群开关控制PluginManagementTools- 插件包管理工具Guard- 广告过滤， 使用 DFA 对消息进行过滤；入群验证码人机检测更新日志更新日志方法列表方法列表插件开发指南插件开发指南DemoTelegram Group：teelebot official（t.me/teelebot_official）Bot :teelebotBot（t.me/teelebotBot）Telegram Group：teelebot体验群（t.me/teelebot_chat）Bot :teelebot（t.me/teelebot）环境要求Python版本teelebot 只支持 Python3.x，不支持Python2.x。本项目在 Python 3.6 及以上版本测试通过。安装1.Pippipinstallteelebot此方式推荐使用Python虚拟环境安装2.Docker# 无代理dockerrun-it\--nameteelebot\--restartalways\-v/path/to/teelebot/config:/config\-v/path/to/teelebot/plugins:/plugins\ghcr.io/plutobell/teelebot:latest# 有代理dockerrun-it\--nameteelebot\--restartalways\--networkhost\-ehttp_proxy="http://ip:port"\-ehttps_proxy="http://ip:port"\-v/path/to/teelebot/config:/config\-v/path/to/teelebot/plugins:/plugins\ghcr.io/plutobell/teelebot:latestTip: 容器创建后请完善配置文件参数，然后重启容器升级1.Pippip install teelebot --upgrade2.Docker# 与Docker容器升级方法相同另外，可通过exec指令在容器中执行命令pip install teelebot --upgrade进行升级使用一行命令启动 (Polling Mode)请自行替换< ... >的内容teelebot -c/--config <config file path> -p/--plugin <plugin path> -k/--key <bot key> -r/--root <your user id>此命令会自动生成在Polling模式下适用的配置文件，并且，-c/--config 参数可以省略(省略将使用默认配置文件路径)。一、运行模式teelebot支持以Webhook模式和Polling模式运行。生产环境推荐使用Webhook模式，而Polling则仅用于开发环境。1、Webhook 模式要以Webhook模式运行，请将配置文件字段webhook设置为True，此模式涉及的配置文件字段如下：[config]webhook=Trueself_signed=Falsecert_key=yourprivatecertpathcert_pub=yourpubliccertpathload_cert=Falseserver_address=yourserveripaddressordomainserver_port=yourserverportlocal_address=webhooklocaladdresslocal_port=webhooklocalportsecret_token=webhooksecrettokenself_signed用于设置是否使用自签名证书，而cert_key和cert_pub是你的证书路径(绝对路径)，load_cert则用于设置 Webhook 是否加载本地证书；server_address为你的服务器公网IP,server_port为服务器的端口(目前 telegram 官方仅支持 443,  80,  88,  8443)，local_address为Webhook 本地监听地址，local_port为 Webhook 本地运行的端口；secret_token则用于设置 Webhook 的secret token。自签名证书生成请参考：Generating a self-signed certificate pair (PEM)2、Polling 模式要以 Polling 模式运行，只需要保证配置文件webhook字段为False即可。此模式最基本的配置文件如下:[config]
key=bot key
root_id=your user id
pool_size=40
webhook=False
debug=False
plugin_dir=your plugin dir二、运行任意路径打开终端，输入以下命令：对于使用程序配置文件默认路径的：输入teelebot回车,正常情况下你应该能看见屏幕提示机器人开始运行。对于命令行手动指定配置文件路径的：输入teelebot -c/--config <configure file path>回车,正常情况下你应该能看见屏幕提示机器人开始运行。更多指令请通过-h/--help查看：usage:-m[-h][-cCONFIG][-kKEY][-rROOT][-pPLUGIN][-mpMAKE_PLUGIN][-L][-C][-hi][-d][-v]teelebotconsolecommandlist

options:-h,--helpshowthishelpmessageandexit-cCONFIG,--configCONFIGspecifytheconfigurationfile-kKEY,--keyKEYspecifythebotapitoken-rROOT,--rootROOTspecifythetelegramuseruser_idofbotadmin-pPLUGIN,--pluginPLUGINspecifythepluginpath-mpMAKE_PLUGIN,--make_pluginMAKE_PLUGINcreateaplugintemplate-L,--logoutlogoutfromthecloudBotAPIserverbeforerunningthebotlocally-C,--closeclosethebotinstancebeforetransferringitbetweenlocalservers-hi,--hide_infohideplugininfo-levelconsolelogs-d,--debugrunteelebotindebugmode-v,--versionshowthecurrentversionofteelebot三、配置文件完整的配置文件如下所示:[config]key=botkeyroot_id=youruseridplugin_dir=yourplugindirpool_size=40# the thread pool size, default 40, range(1, 101)buffer_size=16# the buffer area size, default 16(MB)webhook=Falseself_signed=False# Optional while webhook is Falsecert_key=yourprivatecertpath# Optional while webhook is Falsecert_pub=yourpubliccertpath# Optional while webhook is Falseload_cert=False# Optional while webhook is Falseserver_ip=yourserveripaddress# Optional while webhook is Falseserver_port=yourserverport# Optional while webhook is Falselocal_address=webhooklocaladdress# Optional while webhook is Falselocal_port=webhooklocalport# Optional while webhook is Falsesecret_token=webhooksecrettokendebug=Falsehide_info=Falsedrop_pending_updates=Falselocal_api_server=localapiserveraddress# [Optional]updates_chat_member=False# [Optional]proxy=socks5h://user:pass@host:port# [Optional]在1.13.0及以上版本，支持自动生成配置文件。（默认为Polling模式）1.在命令行未指定配置文件路径的情况下，会在默认配置文件路径下不存在配置文件时自动生成配置文件config.cfg。在Linux下，会自动在用户目录下创建文件夹.teelebot，并生成配置文件config.cfg在Windows下，则会在C:\Users\<username>目录下创建文件夹.teelebot，并生成配置文件config.cfg2.指定配置文件Linux 和 Windows 都可在命令行通过参数手动指定配置文件路径，命令格式：teelebot -c/--config <configure file path>路径必须为绝对路径，并且配置文件名也应当包含在路径内，此情况下会在指定的配置文件不存在时自动生成配置文件 。四、导入使用# 导入Bot类fromteelebotimportBot# 实例化Bot类# 不传参数时会使用teelebot默认配置文件路径下的配置文件实例化Bot类# 在v2.2.0及以上版本，可传递参数覆盖配置文件的设定，可覆盖的参数:#     Bot(key: str = None, debug: bool = False, proxies: dict = None)bot=Bot()# 使用Bot类bot.sendMessage(chat_id="chat_id",text="Hello World!")Tip: 导入使用时需要确保默认配置文件路径中存在配置文件,并且必须的字段已经填写联系我Email：hi#ojoll.com ( # == @ )Blog:北及Telegram Group：teelebot official（t.me/teelebot_official）Telegram Group：teelebot体验群（t.me/teelebot_chat）其他：本repo 的 Issue