mirror of
https://github.com/PaiGramTeam/PaiGram.git
synced 2024-11-16 04:35:49 +00:00
更新文档和 gitignore 文件
This commit is contained in:
CWorld
GitHub
parent
78f78db579
commit
a6223d0ad1
25
.gitignore
vendored
25
.gitignore
vendored
@ -1,10 +1,20 @@
|
||||
/config/config.json
|
||||
**_test.html
|
||||
test_**.html
|
||||
logs/
|
||||
### Code Editor ###
|
||||
|
||||
# VSCode
|
||||
.vscode/
|
||||
*.code-workspace
|
||||
.history
|
||||
.ionide
|
||||
|
||||
# Pycharm
|
||||
*.iws
|
||||
.idea/
|
||||
out/
|
||||
|
||||
### Python ###
|
||||
|
||||
# Environments
|
||||
env/
|
||||
venv/
|
||||
cache/
|
||||
|
||||
@ -14,3 +24,10 @@ __pycache__/
|
||||
*$py.class
|
||||
*.pyo
|
||||
*.pyc
|
||||
|
||||
### Customize ###
|
||||
|
||||
config/config.json
|
||||
**_test.html
|
||||
test_**.html
|
||||
logs/
|
||||
23
README.md
23
README.md
@ -9,17 +9,15 @@
|
||||
|
||||
## 简介
|
||||
|
||||
基于
|
||||
[python-telegram-bot](https://github.com/python-telegram-bot/python-telegram-bot)
|
||||
的 Paimon BOT
|
||||
基于 [python-telegram-bot](https://github.com/python-telegram-bot/python-telegram-bot) 的 Paimon BOT
|
||||
|
||||
## 需求
|
||||
|
||||
### 环境需求
|
||||
|
||||
- Python 3.8+
|
||||
- MySQL
|
||||
- Redis
|
||||
- Python 3.8+
|
||||
- MySQL
|
||||
- Redis
|
||||
|
||||
#### 环境需求需要的注意事项
|
||||
|
||||
@ -33,7 +31,7 @@
|
||||
|
||||
出现相关的 `telegram` 模块导入的 `ImportError` 错误需要你手动执行 `pip install python-telegram-bot==20.0a0`
|
||||
|
||||
请注意你的 python 是否安装 `aiohttp` （ `genshin.py` 的依赖）
|
||||
请注意你的 python 是否安装 `aiohttp` （ `genshin.py` 的依赖）
|
||||
|
||||
如果 `aiohttp` 版本大于 `4.0.0a1`
|
||||
会导致 `redis` 和 `aiohttp` 的依赖 `async-timeout` 版本冲突进而运行代码导致 `TypeError` 异常
|
||||
@ -47,8 +45,9 @@
|
||||
这个项目目前正在扩展，加入更多原神相关娱乐和信息查询功能，敬请期待。
|
||||
|
||||
## Thanks
|
||||
| Nickname | Introduce |
|
||||
|:-----------------------------------------------------:|-------------------|
|
||||
| [原神抽卡全机制总结](https://www.bilibili.com/read/cv10468091) | 本项目抽卡模拟器使用的逻辑 |
|
||||
| [西风驿站](https://bbs.mihoyo.com/ys/collection/307224) | 本项目攻略图图源 |
|
||||
| [Yunzai-Bot](https://github.com/Le-niao/Yunzai-Bot) | 本项使用的抽卡图片和前端资源来源 |
|
||||
|
||||
| Nickname | Introduce |
|
||||
| :----------------------------------------------------------: | -------------------------------- |
|
||||
| [原神抽卡全机制总结](https://www.bilibili.com/read/cv10468091) | 本项目抽卡模拟器使用的逻辑 |
|
||||
| [西风驿站](https://bbs.mihoyo.com/ys/collection/307224) | 本项目攻略图图源 |
|
||||
| [Yunzai-Bot](https://github.com/Le-niao/Yunzai-Bot) | 本项使用的抽卡图片和前端资源来源 |
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
## 说明
|
||||
|
||||
改目录存放 BOT 的工作队列呸注册和具体实现
|
||||
改目录存放 BOT 的工作队列、注册和具体实现
|
||||
|
||||
## 基础代码
|
||||
|
||||
@ -15,7 +15,6 @@ from jobs.base import RunDailyHandler
|
||||
from logger import Log
|
||||
from manager import listener_jobs_class
|
||||
|
||||
|
||||
@listener_jobs_class()
|
||||
class JobTest:
|
||||
|
||||
@ -36,4 +35,4 @@ class JobTest:
|
||||
|
||||
jobs 模块下的类必须提供 `build_jobs` 类方法作为构建相应处理程序给 `handle.py`
|
||||
|
||||
只需在构建的类前加上 `@listener_jobs_class()` 修饰器即可
|
||||
只需在构建的类前加上 `@listener_jobs_class()` 修饰器即可
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
# metadata 目录说明
|
||||
|
||||
| FileName | Introduce |
|
||||
|:------------:|------------|
|
||||
| shortname.py | 记录短名称MAP |
|
||||
| FileName | Introduce |
|
||||
| :----------: | ------------- |
|
||||
| shortname.py | 记录短名称MAP |
|
||||
@ -1,6 +1,5 @@
|
||||
# model 目录说明
|
||||
|
||||
|
||||
## apihelpe 模块
|
||||
|
||||
用于获取米忽悠BBS的数据写的请求模块
|
||||
@ -23,6 +22,6 @@
|
||||
|
||||
### 感谢
|
||||
|
||||
| Nickname | Contribution |
|
||||
|:----------------------------------------------------------:|--------------|
|
||||
| [Crawler-ghhw](https://github.com/DGP-Studio/Crawler-ghhw) | 本项目参考的爬虫代码 |
|
||||
| Nickname | Contribution |
|
||||
| :--------------------------------------------------------: | -------------------- |
|
||||
| [Crawler-ghhw](https://github.com/DGP-Studio/Crawler-ghhw) | 本项目参考的爬虫代码 |
|
||||
|
||||
@ -43,7 +43,7 @@ plugins 模块下的类必须提供 `create_handlers` 类方法作为构建相
|
||||
|
||||
必要的函数必须捕获异常后通知用户或者直接抛出异常
|
||||
|
||||
入口函数必须使用 `@restricts()` 修饰器 防止洪水攻击
|
||||
入口函数必须使用 `@restricts()` 修饰器 防止洪水攻击
|
||||
|
||||
我也不知道从那个版本开始 `plugins` 文件夹下的全部模块无需再次修改 `handler` 文件实现注册处理程序
|
||||
|
||||
@ -51,4 +51,4 @@ plugins 模块下的类必须提供 `create_handlers` 类方法作为构建相
|
||||
|
||||
**注意：`@restricts()` 修饰器带参，必须带括号，否则会出现调用错误**
|
||||
|
||||
如果 `service` 需要全局共用，可以参考 `daily_note.py` 代码
|
||||
如果 `service` 需要全局共用，可以参考 `daily_note.py` 代码
|
||||
|
||||
@ -4,12 +4,12 @@
|
||||
再使用无头浏览器 `playwright` 截图发送给用户
|
||||
|
||||
## background 来源
|
||||
|
||||
|
||||
原神官方
|
||||
|
||||
## 使用的styles
|
||||
|
||||
| ProjectName | Contribution |
|
||||
|:-------------------------------------------------:|------------------|
|
||||
| [tailwindcss](https://tailwindcss.com/) | 本项目使用的CSS框架 |
|
||||
| [fontawesome](https://fontawesome.dashgame.com/) | 一套绝佳的图标字体库和CSS框架 |
|
||||
|
||||
|
||||
@ -2,16 +2,15 @@
|
||||
|
||||
## 文件说明
|
||||
|
||||
| FileName | Introduce |
|
||||
|:----------:|------------|
|
||||
| init | 服务初始化 |
|
||||
| admin | 用于机器人管理 |
|
||||
| base | 基本数据类型 |
|
||||
| cache | 相关Redis缓存 |
|
||||
| FileName | Introduce |
|
||||
| :--------: | -------------------- |
|
||||
| init | 服务初始化 |
|
||||
| admin | 用于机器人管理 |
|
||||
| base | 基本数据类型 |
|
||||
| cache | 相关Redis缓存 |
|
||||
| gacha | 抽卡卡池网络信息请求 |
|
||||
| quiz | 进群问答 |
|
||||
| repository | 相关MySQL通信 |
|
||||
| quiz | 进群问答 |
|
||||
| repository | 相关MySQL通信 |
|
||||
| template | 模板和无头浏览器渲染 |
|
||||
| user | 用户管理 |
|
||||
| wish | 抽卡卡池逻辑请求 |
|
||||
|
||||
| user | 用户管理 |
|
||||
| wish | 抽卡卡池逻辑请求 |
|
||||
|
||||
Loading…
Reference in New Issue
Block a user