hillerliao / RSSHub-python

A RSSHub for Pythonista

RSSHub

🍰 Everything can be RSS

RSSHub is a lightweight, easily extensible RSS generator that can create RSS feeds for any type of content.

This project is a Python implementation of the original RSSHub.

Actually writing crawlers in Python is more convenient than JS :p

DEMO address: https://pyrsshub.vercel.app

Community

Discord Server: https://discord.gg/4BZBZuyx7p

RSS Filtering

You can filter RSS content using the following query strings:

• include_title: Search titles (supports multiple keywords)
• include_description: Search descriptions
• exclude_title: Exclude titles
• exclude_description: Exclude descriptions
• limit: Limit number of items

How to Contribute RSS

1. Fork this repository
2. Create a new spider directory and script in the spiders folder, write your crawler (refer to my crawler tutorial)
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

Deployment

Local Testing

First ensure pipenv is installed

git clone https://github.com/alphardex/RSSHub-python
cd RSSHub-python
pipenv install --dev
pipenv shell
flask run

Production Environment

gunicorn main:app -b 0.0.0.0:5000

Deploy to Vercel

Docker Deployment

Create docker container: docker run -dt --name pyrsshub -p 5000:5000 hillerliao/pyrsshub:latest

Requirements

• Python 3.8