add submit issue template, update README.md

This commit is contained in:
BennyThink
2021-02-09 10:01:59 +08:00
parent e072de44db
commit c397f807c0
4 changed files with 94 additions and 21 deletions

View File

@@ -4,13 +4,40 @@
[![codecov](https://codecov.io/gh/tgbot-collection/YYeTsBot/branch/master/graph/badge.svg?token=ZL1GCIF95D)](https://codecov.io/gh/tgbot-collection/YYeTsBot)
人人影视bot[戳我使用](https://t.me/yyets_bot)
* 人人影视bot[戳我使用](https://t.me/yyets_bot)
此机器人长期维护,如果遇到问题可以发送报告给我。
* 人人影视分享站,[戳我使用](https://yyets.dmesg.app/)
机器人和网站由我长期维护如果遇到问题可以提issue。
- [使用说明](#使用说明)
- [命令](#命令)
- [截图](#截图)
* [常规搜索](#常规搜索)
* [资源分享站截图](#资源分享站截图)
* [指定字幕组搜索](#指定字幕组搜索)
- [部署运行](#部署运行)
* [docker-compose](#docker-compose)
* [常规方式](#常规方式)
+ [1. 环境](#1-环境)
+ [2. 配置TOKEN](#2-配置TOKEN)
+ [3. 导入数据(可选)](#3-导入数据可选)
+ [4. 运行](#4-运行)
+ [5. systemd 单元文件](#5-systemd-单元文件)
+ [6. 网站部署运行方式](#6-网站部署运行方式)
- [TODO](#todo)
- [归档资源下载](#归档资源下载)
- [开发](#开发)
* [添加新的资源网站](#添加新的资源网站)
* [health check](#health-check)
- [Credits](#credits)
- [支持我](#支持我)
- [License](#license)
[toc]
# 使用说明
直接发送想要看的剧集名称就可以了可选分享网页或者链接ed2k和磁力链接
支持字幕侠、人人影视(目前人人影视官网无法打开,暂时无法使用)、人人影视离线资源
@@ -19,10 +46,9 @@
**由于译名的不同,建议输入部分译名,然后从列表中进行选择。比如说想看权力的游戏第四季,那么直接搜索"权力的游戏"就可以了。**
# 资源分享站
[点此访问](https://yyets.dmesg.app/)
# 命令
```
start - 开始使用
help - 帮助
@@ -36,31 +62,42 @@ yyets_offline - 人人影视离线数据
```
# 截图
## 常规搜索
![](assets/1.png)
## 资源分享站截图
~~目前使用的是我的 Cloudflare Worker Site~~
![](assets/2.png)
## 指定字幕组搜索
目前只支持YYeTsOffline和ZimuxiaOnline
![](assets/3.png)
# 部署运行
## docker-compose 部署方法
## docker-compose
参见 [这里](https://github.com/tgbot-collection/BotsRunner)
## 常规方式
### 1. 环境
推荐使用Python 3.6+,环境要求
* redis
* 可选MongoDB
```bash
pip install -r requirements.txt
```
### 2. 配置TOKEN
修改`config.py`,根据需求修改如下配置项
@@ -71,24 +108,33 @@ pip install -r requirements.txt
* MAINTAINER维护者的Telegram UserID
* REDISredis的地址一般为localhost
* MONGODB: mongodb的地址
### 3. 导入数据(可选)
如果使用yyets那么需要导入数据到MongoDB。可以在将数据导入到MySQL之后使用如下脚本导入数据到MongoDB
```shell
python3 web/prepare/convert_db.py
```
**不再兼容旧版本数据**
### 4. 运行
```bash
python /path/to/YYeTsBot/yyetsbot/bot.py
```
### 5. systemd 单元文件
参考 `yyets.service`
### 网站部署运行方式
### 6. 网站部署运行方式
参考 `worker``web`目录下的 `README`
# TODO
- [x] 添加对FIX的支持
- [x] 文件/函数重命名,类化
- [x] 优先字幕组顺序设置 - 动态设置
@@ -97,16 +143,19 @@ python /path/to/YYeTsBot/yyetsbot/bot.py
- [x] 独立网站
- [ ] test case...啊不想写
# 归档资源下载
* 包含了2021年1月11日为止的人人影视最新资源有兴趣的盆友可以用这个数据进行二次开发[戳我查看详情](https://t.me/mikuri520/668)
* 字幕侠离线数据库 [从这里下载](https://t.me/mikuri520/715),这个数据比较粗糙,并且字幕侠网站还在,因此不建议使用这个
# 开发
## 添加新的资源网站
欢迎各位开发提交新的资源网站!方法非常简单,重写 `BaseFansub`,按照约定的格式返回数据。
然后把类名字添加到 `FANSUB_ORDER` 就可以了!是不是很简单!
欢迎各位开发提交新的资源网站!方法非常简单,重写 `BaseFansub`,按照约定的格式返回数据。 然后把类名字添加到 `FANSUB_ORDER` 就可以了!是不是很简单!
## health check
有时不知为何遇到了bot卡死无任何反馈。😂~~这个时候需要client api了~~😂
好的这个原因找到了是因为有时爬虫会花费比较长的时间然后pytelegrambotapi默认只有两个线程那么后续的操作就会被阻塞住。
@@ -120,16 +169,17 @@ python /path/to/YYeTsBot/yyetsbot/bot.py
* [磁力下载站](http://oabt005.com/home.html)
* [FIX字幕侠](https://www.zimuxia.cn/)
# 支持我
# 支持我
觉得本项目对你有帮助?你可以通过以下方式表达你的感受:
* 感谢字幕组
* 点一个🌟和fork🍴
* 点一个star🌟和fork🍴
* 宣传,使用,提交问题报告
* 收藏[我的博客](https://dmesg.app/)
* [Telegram Channel](https://t.me/mikuri520)
* 捐助我,[给我买杯咖啡?](https://www.buymeacoffee.com/bennythink)
# License
[MIT](LICENSE)

View File

@@ -1,21 +1,41 @@
# web端
**注意源代码中包含Google Analytics分析代码**
**注意源代码中包含Google Analytics分析代码`index.html`, `search.html`和`resource.html`**
# requirements
* tornado
* mongodb
* pymongo
* cryptography
# 导入数据
**注意不兼容channel中分享的MongoDB数据**
暂时没有现成到数据一个workaround如下
1. 下载MySQL数据[戳我查看详情](https://t.me/mikuri520/668)
暂时没有开箱即用的数据一个workaround如下
1. 下载[MySQL的数据](https://t.me/mikuri520/668)
1. 导入数据到MySQL
2. 运行 `python prepare/convert_db.py`
# 运行
`python server.py`
# Docker
参考[这里](https://github.com/BennyThink/WebsiteRunner)
# MongoDB index
```shell
use zimuzu;
db.getCollection('yyets').createIndex({"data.info.id": 1});
db.getCollection('yyets').createIndex({"data.info.views" : -1});
db.getCollection('yyets').createIndex({"data.info.area" : 1});
db.getCollection('yyets').getIndexes();
```

View File

@@ -123,6 +123,7 @@
<h3>
联系我 <a style="text-decoration: none;color: green" href="https://t.me/BennyThink">Benny 小可爱</a>
YYeTs 机器人<a style="text-decoration: none;color: green" href="https://t.me/yyets_bot">Telegram Bot</a>
Telegram <a style="text-decoration: none;color: green" href="https://t.me/mikuri520">Channel</a>
开源 <a style="text-decoration: none;color: green" href="https://github.com/tgbot-collection/YYeTsBot">GitHub</a>
我的博客 <a style="text-decoration: none;color: green" href="https://dmesg.app/">土豆不好吃</a>
</h3>

View File

@@ -68,6 +68,7 @@
联系我 <a style="text-decoration: none;color: green" href="https://t.me/BennyThink">Benny 小可爱</a>
YYeTs 机器人<a style="text-decoration: none;color: green" href="https://t.me/yyets_bot">Telegram Bot</a>
开源 <a style="text-decoration: none;color: green" href="https://github.com/tgbot-collection/YYeTsBot">GitHub</a>
Telegram <a style="text-decoration: none;color: green" href="https://t.me/mikuri520">Channel</a>
我的博客 <a style="text-decoration: none;color: green" href="https://dmesg.app/">土豆不好吃</a>
</h3>
</div>
@@ -111,7 +112,8 @@
}
if (data.length === 0) {
div.innerHTML = `<h2>没有搜索到结果 (ノへ ̄、)</h2>`
let issueLink = `https://github.com/tgbot-collection/YYeTsBot/issues/new?assignees=BennyThink&labels=new&title=增加新资源【xxx】&body=请准确填写新资源的下载地址和大小,最好能够上传类似[如下格式的json文件](https://github.com/tgbot-collection/YYeTsBot/blob/master/management/format.json)。若不遵守此规则issue将被关闭。谢谢。`;
div.innerHTML = `<h2>没有搜索到结果 (ノへ ̄、)</h2><a style="text-decoration: none;color: cornflowerblue" target="_blank" href="${issueLink}">点我去补充信息</a>`
}
}