Skip to main content

我们为你做了一个你无法拒绝的包装

项目描述

python-telegram-bot 徽标

我们为你做了一个你无法拒绝的包装

我们的Telegram 组有一个充满活力的开发者社区,他们互相帮助。加入我们!

请继续关注我们的 电报频道上的图书馆更新和新版本。

PyPi 包版本 支持的 Python 版本 支持的 Bot API 版本 PyPi 包月度下载 文件状态 LGPLv3 许可证 Github 操作工作流程 代码覆盖率 解决问题的中位时间 代码质量:Codacy 代码质量:DeepSource https://img.shields.io/badge/code%20style-black-000000.svg 电报群

目录

介绍

这个库为 Telegram Bot API提供了一个纯 Python 接口。它与 Python 3.7+ 版本兼容。PTB 也可能适用于PyPy,尽管之前存在很多问题。因此,PyPy 不受官方支持。

除了纯 API 实现之外,该库还具有许多高级类,使机器人的开发变得简单明了。这些类包含在 telegram.ext子模块中。

没有 telegram.ext的纯 API 实现可作为独立包python-telegram-bot-raw 使用有关详细信息,请参见此处。

笔记

同时安装python-telegram-botpython-telegram-bot-raw会导致不希望的副作用,所以只安装两者之一

电报 API 支持

支持Telegram Bot API 6.2的所有类型和方法。

安装

您可以使用以下命令安装或升级 python-telegram-bot:

$ pip install python-telegram-bot --upgrade

或者您可以从源代码安装:

$ git clone https://github.com/python-telegram-bot/python-telegram-bot --recursive
$ cd python-telegram-bot
$ python setup.py install

如果您已经有一个以前克隆的本地存储库,您应该在安装之前初始化添加的 urllib3 子模块:

$ git submodule update --init --recursive

可选依赖项

PTB 可以安装可选的依赖项:

  • pip install python-telegram-bot[passport]安装密码库。如果您想使用 Telegram Passport 相关功能,请使用此选项。

  • pip install python-telegram-bot[ujson]安装ujson库。然后它将用于 JSON 解码和编码,与标准json库相比可以提高速度。

  • pip install python-telegram-bot[socks]安装PySocks库。如果您想在 Socks5 服务器后面工作,请使用它。

入门

我们的 Wiki 包含大量资源,可帮助您开始使用python-telegram-bot

其他参考:

以身作则

我们相信学习这个包的最好方法是通过例子。以下是一些示例供您查看。即使这不是您的学习方法,请查看echobot.py,它是大多数机器人的事实上的基础。最重要的是,这些示例的代码已发布到公共领域,因此您可以从获取代码并在其之上构建开始。

访问此页面以发现官方示例或查看wiki上的示例以查看社区构建的其他机器人。

日志记录

该库使用日志记录模块。要将日志记录设置到标准输出,请输入:

import logging
logging.basicConfig(level=logging.DEBUG,
                    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')

在脚本的开头。

您还可以通过调用logging.getLogger()并设置所需的日志级别来在应用程序中使用日志:

logger = logging.getLogger()
logger.setLevel(logging.INFO)

如果您想要 DEBUG 日志:

logger.setLevel(logging.DEBUG)

文档

python-telegram-bot的文档位于readthedocs.io

获得帮助

您可以通过多种方式获得帮助:

  1. 我们的Telegram 组有一个充满活力的开发者社区,他们互相帮助。加入我们!

  2. 通过创建问题讨论来报告错误、请求新功能或提出问题。

  3. 我们的Wiki 页面提供了越来越多的资源。

  4. 您甚至可以使用python-telegram-bot 标签在 Stack Overflow 上寻求帮助。

贡献

欢迎各种规模的贡献。请查看我们的贡献指南以开始使用。您还可以通过报告错误来提供帮助。

捐赠

有时我们会被问到是否接受捐款以支持发展。虽然我们很欣赏这个想法,但维护 PTB 是我们的爱好,我们几乎没有运行成本。因此,我们没有任何设置来接受捐赠。如果您仍想捐赠,我们恳请您捐赠给您选择的另一个开源项目/倡议。

执照

您可以复制、分发和修改软件,前提是修改是在LGPL-3下免费描述和许可的。衍生作品(包括修改或静态链接到库的任何内容)只能在 LGPL-3 下重新分发,但使用该库的应用程序不必如此。