|
1 | | -# RSSHub |
2 | | - |
3 | | -> 🍰 Everything can be RSS |
4 | | -
|
5 | | -RSSHub is a lightweight, easily extensible RSS generator that can create RSS feeds for any type of content. |
6 | | - |
7 | | -This project is a Python implementation of the [original RSSHub](https://github.com/DIYgod/RSSHub). |
8 | | - |
9 | | -**Actually writing crawlers in Python is more convenient than JS :p** |
10 | | - |
11 | | -DEMO address: https://pyrsshub.vercel.app |
12 | | - |
13 | | -## Community |
14 | | - |
15 | | -Discord Server: [https://discord.gg/4BZBZuyx7p](https://discord.gg/4BZBZuyx7p) |
16 | | - |
17 | | -## RSS Filtering |
18 | | - |
19 | | -You can filter RSS content using the following query strings: |
20 | | - |
21 | | -- include_title: Search titles (supports multiple keywords) |
22 | | -- include_description: Search descriptions |
23 | | -- exclude_title: Exclude titles |
24 | | -- exclude_description: Exclude descriptions |
25 | | -- limit: Limit number of items |
26 | | - |
27 | | -## How to Contribute RSS |
28 | | - |
29 | | -1. Fork this repository |
30 | | -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)) |
31 | | -3. Add corresponding routes in main.py under blueprints (following existing route formats) |
32 | | -4. Write documentation in feeds.html under templates/main directory (follow existing formats) |
33 | | -5. Submit a PR |
34 | | - |
35 | | -## Deployment |
36 | | - |
37 | | -### Local Testing |
38 | | - |
39 | | -First ensure [pipenv](https://github.com/pypa/pipenv) is installed |
40 | | - |
41 | | -```bash |
42 | | -git clone https://github.com/alphardex/RSSHub-python |
43 | | -cd RSSHub-python |
44 | | -pipenv install --dev |
45 | | -pipenv shell |
46 | | -flask run |
47 | | -``` |
48 | | - |
49 | | -### Production Environment |
50 | | - |
51 | | -```bash |
52 | | -gunicorn main:app -b 0.0.0.0:5000 |
53 | | -``` |
54 | | - |
55 | | -### Deploy to Vercel |
56 | | - |
57 | | -[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fhillerliao%2Frsshub-python) |
58 | | - |
59 | | -### Docker Deployment |
60 | | - |
61 | | -Create docker container: `docker run -dt --name pyrsshub -p 5000:5000 hillerliao/pyrsshub:latest` |
62 | | - |
63 | | -## Requirements |
64 | | - |
65 | | -- Python 3.8 |
| 1 | +# RSSHub |
| 2 | + |
| 3 | +> 🍰 Everything can be RSS |
| 4 | +
|
| 5 | +RSSHub is a lightweight, easily extensible RSS generator that can create RSS feeds for any type of content. |
| 6 | + |
| 7 | +This project is a Python implementation of the [original RSSHub](https://github.com/DIYgod/RSSHub). |
| 8 | + |
| 9 | +**Actually writing crawlers in Python is more convenient than JS :p** |
| 10 | + |
| 11 | +DEMO address: https://pyrsshub.vercel.app |
| 12 | + |
| 13 | +## Community |
| 14 | + |
| 15 | +Discord Server: [https://discord.gg/4BZBZuyx7p](https://discord.gg/4BZBZuyx7p) |
| 16 | + |
| 17 | +## RSS Filtering |
| 18 | + |
| 19 | +You can filter RSS content using the following query strings: |
| 20 | + |
| 21 | +- include_title: Search titles (supports multiple keywords) |
| 22 | +- include_description: Search descriptions |
| 23 | +- exclude_title: Exclude titles |
| 24 | +- exclude_description: Exclude descriptions |
| 25 | +- limit: Limit number of items |
| 26 | + |
| 27 | +## How to Contribute RSS |
| 28 | + |
| 29 | +1. Fork this repository |
| 30 | +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)) |
| 31 | +3. Add corresponding routes in main.py under blueprints (following existing route formats) |
| 32 | +4. Write documentation in feeds.html under templates/main directory (follow existing formats) |
| 33 | +5. Submit a PR |
| 34 | + |
| 35 | +## Deployment |
| 36 | + |
| 37 | +### Local Testing |
| 38 | + |
| 39 | +First ensure [pipenv](https://github.com/pypa/pipenv) is installed |
| 40 | + |
| 41 | +```bash |
| 42 | +git clone https://github.com/alphardex/RSSHub-python |
| 43 | +cd RSSHub-python |
| 44 | +pipenv install --dev |
| 45 | +pipenv shell |
| 46 | +flask run |
| 47 | +``` |
| 48 | + |
| 49 | +### Production Environment |
| 50 | + |
| 51 | +```bash |
| 52 | +gunicorn main:app -b 0.0.0.0:5000 |
| 53 | +``` |
| 54 | + |
| 55 | +### Deploy to Vercel |
| 56 | + |
| 57 | +[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fhillerliao%2Frsshub-python) |
| 58 | + |
| 59 | +### Docker Deployment |
| 60 | + |
| 61 | +Create docker container: `docker run -dt --name pyrsshub -p 5000:5000 hillerliao/pyrsshub:latest` |
| 62 | + |
| 63 | +## Requirements |
| 64 | + |
| 65 | +- Python 3.8 |
0 commit comments