BotListBot

电报@BotListBot

这是负责维护 Telegram BotList 的聊天机器人，这是一个社区驱动的渠道，用于收集 Telegram 上最好的机器人。

该机器人通过充当 BotList 的镜像来简化导航，并自动执行 BotListChat 社区提交、审查和发布机器人的过程。

该存储库旨在为机器人构建者提供灵感和技术指导，主要针对使用令人惊叹的 python-telegram-bot 库的人们。

JosXa/BotListBot 根据 MIT 许可证获得许可。

设置指南

先决条件

强制的

• Python 3.7.x
• PostgreSQL 数据库实例或 Docker（见下文）
• 全局安装 Pipenv ( pip install pipenv )
• 您自己的用于本地开发的机器人代币

选修的

• Sentry.io 帐户（日志记录）
• 兼容 S3 的对象存储（例如 Minio）

开发设置

使用 GitHub 代码空间和 VSCode（推荐）

推荐的原因是它是让您入门最快的选择。

1. 在 GitHub Codespaces 上，输入“ JosXa/BotListBot ”并创建您的开发容器。
2. 修改template.env中的变量并将文件另存为.env并保存在 checkout 的根文件夹中。
3. 通过pipenv run python -m botlistbot.main运行项目

使用 PyCharm...

使用 Docker 设置 PostgreSQL 数据库实例

1. 安装 Docker
2. 运行docker-compose up -d
3. 通过pipenv run python scripts/initialize_database.py seed创建数据库并为其设定种子
4. 要停止数据库，请运行docker-compose down

设置 BotListBot

1. VCS -> 从版本控制中获取... -> https://github.com/JosXa/BotListBot （或您自己的分支）
2. 使用 Pipenv （不是 virtualenv ）添加一个新项目 Interpreter 并让 PyC​​harm 为您安装软件包
3. 修改template.env中的变量并将文件保存为根文件夹中的.env
4. 运行文件scripts/initialize_database.py一次。然后打开其运行配置，将单词“seed”添加到参数列表中，然后再次运行它。这将用一些初始的、必需的值填充数据库。
5. 使用默认配置运行botlistbot/main.py

不使用 PyCharm...

使用 Docker 设置 PostgreSQL 数据库实例

1. 安装 Docker
2. 运行docker-compose up -d
3. 通过pipenv run python scripts/initialize_database.py seed创建数据库并为其设定种子
4. 要停止数据库，请运行docker-compose down

设置 BotListBot

1. 从 GitHub 克隆： git clone https://github.com/JosXa/BotListBot （或您自己的分支）
2. 运行pipenv install
3. 修改template.env中的变量并将文件另存为.env并保存在 checkout 的根文件夹中。
4. 通过pipenv run python scripts/initialize_database.py seed创建数据库并为其设定种子
5. 通过pipenv run python -m botlistbot.main运行项目

有关配置的更多详细信息

如果您查看 settings.py，您可以看到一堆通过decouple.config(...)调用检索的环境变量。这些设置可以通过您在根文件夹中创建的.env文件进行控制。