Merge pull request #32 from Robinbinu/patch-1

Added English Translation to README.md for Global Accessibility
This commit is contained in:
Zhihai Liao
2025-07-04 10:34:58 +08:00
committed by GitHub

View File

@@ -1,46 +1,44 @@
# RSSHub
> 🍰 万物皆可 RSS
> 🍰 Everything can be RSS
RSSHub 是一个轻量、易于扩展的 RSS 生成器,可以给任何奇奇怪怪的内容生成 RSS 订阅源
RSSHub is a lightweight, easily extensible RSS generator that can create RSS feeds for any type of content.
本项目是[RSSHub](https://github.com/DIYgod/RSSHub)的Python实现。
This project is a Python implementation of the [original RSSHub](https://github.com/DIYgod/RSSHub).
**Actually writing crawlers in Python is more convenient than JS :p**
**其实用Python写爬虫要比JS更方便:p**
DEMO address: https://pyrsshub.vercel.app
DEMO地址https://pyrsshub.vercel.app
## Community
Discord Server: [https://discord.gg/4BZBZuyx7p](https://discord.gg/4BZBZuyx7p)
## 交流
## RSS Filtering
Discord Server [https://discord.gg/4BZBZuyx7p](https://discord.gg/4BZBZuyx7p)
You can filter RSS content using the following query strings:
## RSS过滤
- include_title: Search titles (supports multiple keywords)
- include_description: Search descriptions
- exclude_title: Exclude titles
- exclude_description: Exclude descriptions
- limit: Limit number of items
你可以通过以下查询字符串来过滤RSS的内容
## How to Contribute RSS
- include_title: 搜索标题,支持多关键词
- include_description: 搜索描述
- exclude_title: 排除标题
- exclude_description: 排除描述
- limit: 限制条数
1. Fork this repository
2. Create a new spider directory and script in the spiders folder, write your crawler (refer to my [crawler tutorial](https://juejin.cn/post/6953881777756700709))
3. Add corresponding routes in main.py under blueprints (following existing route formats)
4. Write documentation in feeds.html under templates/main directory (follow existing formats)
5. Submit a PR
## 贡献 RSS 方法
## Deployment
1. fork这份仓库
2. 在spiders文件夹下创建新的爬虫目录和脚本编写爬虫参考我的[爬虫教程](https://juejin.cn/post/6953881777756700709)
3. 在blueprints的main.py中添加对应的路由按照之前路由的格式
4. 在templates中的main目录下的feeds.html上写上说明文档同样可参照格式写
5. 提pr
### Local Testing
## 部署
First ensure [pipenv](https://github.com/pypa/pipenv) is installed
### 本地测试
首先确保安装了[pipenv](https://github.com/pypa/pipenv)
``` bash
```bash
git clone https://github.com/alphardex/RSSHub-python
cd RSSHub-python
pipenv install --dev
@@ -48,19 +46,19 @@ pipenv shell
flask run
```
### 生产环境
### Production Environment
``` bash
```bash
gunicorn main:app -b 0.0.0.0:5000
```
### 部署到 Vercel
### Deploy to Vercel
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fhillerliao%2Frsshub-python)
### Docker 部署
### Docker Deployment
创建docker容器 `docker run -dt --name pyrsshub -p 5000:5000 hillerliao/pyrsshub:latest`
Create docker container: `docker run -dt --name pyrsshub -p 5000:5000 hillerliao/pyrsshub:latest`
## Requirements