Skip to content
RSS feed reader for Python 3
Python HTML JavaScript Other
Branch: master
Clone or download
Latest commit 732dbe2 Nov 30, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
feedsubs
misc Add screenshot to README Dec 17, 2018
reader Grow the field storing attachement sizes Sep 17, 2019
um Handle fetching background message when request is not available Jul 3, 2019
waitressd Rely on Django to apply logging configuration Sep 2, 2018
.coveragerc Remove spinachd from style and coverage checks Oct 10, 2018
.dockerignore Refactor create_feed task Dec 13, 2018
.gitattributes Allow to edit tags attached to feeds Mar 18, 2018
.gitignore Refactor create_feed task Dec 13, 2018
.travis.yml Document how to get started with the code Dec 16, 2018
Dockerfile
LICENSE Create base for packaging Feb 6, 2018
MANIFEST.in Document how to get started with the code Dec 16, 2018
Makefile Rename project into Feedsubs Feb 28, 2018
README.rst Release version 0.0.2 Dec 17, 2018
requirements.txt Upgrade dependencies Nov 30, 2019
setup.cfg Automatically run tests with Travis CI Oct 6, 2018
setup.py Replace Raven with new Sentry SDK Jun 10, 2019

README.rst

Feedsubs

https://travis-ci.org/NicolasLM/feedsubs.svg?branch=master https://coveralls.io/repos/github/NicolasLM/feedsubs/badge.svg?branch=master

RSS feed reader for Python 3.

https://raw.githubusercontent.com/NicolasLM/feedsubs/master/misc/screenshot.png

Features:

  • Support for RSS, Atom and JSON feeds
  • Background synchronization
  • Caching and resizing of image embedded in feeds
  • Removal of tracking pixels
  • Grouping of feeds with tags
  • Multi-users
  • MIT licensed

Hosted service

A free hosted version runs Feedsubs at feedsubs.com, it is the easiest way to start using the software without installing anything.

Development guide

Feedsubs is a typical Django project, anyone familiar with Django will feel right at home. It requires:

  • Python 3.6+
  • Postgresql database
  • Redis server for background tasks

Quickstart:

git clone git@github.com:NicolasLM/feedsubs.git
cd feedsubs/
python3 -m venv venv
source venv/bin/activate
pip install -e .[dev]
touch .env  # Put SECRET_KEY=foo and DB_PASSWORD=foo there
manage.py migrate
manage.py runserver

Background task workers can be started with:

manage.py spinach

Self-hosting

Feedsubs is a feed reader primarily focused toward large multi-users installations, it may not be the easiest choice to host as a personal reader. That being said, Docker makes it simple to deploy:

  • Make your own settings module based on feedsubs/settings/prod.py
  • docker run -d -v path/to/my_settings.py:/my_settings.py -e DJANGO_SETTINGS_MODULE=my_settings -p 8000:8000 nicolaslm/feedsubs waitress
  • Serve the port 8000 through a reverse proxy like nginx or caddy

Users can also deploy Feedsubs with pip instead of Docker:

pip install feedsubs[prod]
manage.py waitress
You can’t perform that action at this time.