用于创建 Twitch Bots 的 python 包
项目描述
J-核心
这个框架是一个简单的包装器,用于使用 Python创建Twitch机器人。用于 twitch 和 discord的Jarvis 聊天机器人是使用 J-Core 框架构建的,用于其 Twitch 组件。
全套文档仍在开发中,但下面概述了入门指南。
入门
先决条件
要开始使用 J-Core 框架创建机器人非常简单,但它确实需要您在计算机上安装Python 。
一些操作系统预装了 python(例如 MacOS 和大多数 Linux 系统),但如果你在 Windows 上,你需要先下载 Python来创建一个机器人。
安装 Python 后,您可以使用它pip来安装 J-Core 框架并开始创建您的第一个机器人。
安装
使用 pip 安装 J-Core 框架:
pip install jcore
要使用此存储库安装:
- 使用克隆目录
git clone - 导航到目录并使用
pip install
创建一个简单的机器人
要创建一个简单的机器人,首先创建一个名为的新 python 文件simple_bot.py并将下面的代码复制到文件中。
import asyncio
import jcore
from jcore.message import CommandMessage
class SimpleBot(jcore.Client):
async def on_command(self, message: CommandMessage):
if message.KEYWORD == "hi":
await message.send(f"hello {message.display_name}")
if __name__ == "__main__":
client = SimpleBot()
loop = asyncio.get_event_loop()
loop.run_until_complete(client.run())
loop.close()
接下来,创建一个名为的文件config.json并将以下代码段复制到该文件中。
{
"nick": "<nick>",
"token": "<token>",
"channels": [
"<channel>",
"<channel>",
"<channel>"
]
}
代替:
<nick>使用您的机器人帐户的用户名。<token>使用您的机器人的 oauth 令牌。有关生成 oauth 令牌的更多信息,请参阅Twitch 文档 - 获取令牌。<channel>与您要连接的频道。
设置完所有值后,您可以使用以下命令启动您的机器人:
python3 simple_bot.py
或者
py simple_bot.py
添加日志记录
如果您需要查看 bot 框架的日志记录输出,您可以通过将日志记录导入添加到文件顶部来配置日志记录:
import asyncio
import jcore
from jcore.message import CommandMessage
import logging
然后将代码的主要部分更新为以下内容:
if __name__ == "__main__":
logging.basicConfig(level=logging.INFO, format='%(asctime)s [%(levelname)s] %(name)s: %(message)s')
client = SimpleBot()
loop = asyncio.get_event_loop()
loop.run_until_complete(client.run())
loop.close()
有关使用日志库的更多信息,请参阅python 日志记录文档。
例子
上面的这些示例以及更多示例可以在示例文件夹中找到。
支持
如果您需要任何进一步的支持,请加入discord并向社区寻求帮助。
项目详情
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。
源分布
jcore-0.2.0.552.tar.gz
(32.7 kB
查看哈希)
内置分布
jcore-0.2.0.552-py3-none-any.whl
(34.4 kB
查看哈希