Skip to main content

RSS feed reader for Python 3

Project description

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

Copyright (c) 2018 Nicolas Le Manchet

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

feedsubs-0.0.2.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

feedsubs-0.0.2-py3-none-any.whl (1.6 MB view details)

Uploaded Python 3

File details

Details for the file feedsubs-0.0.2.tar.gz.

File metadata

  • Download URL: feedsubs-0.0.2.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.6.1

File hashes

Hashes for feedsubs-0.0.2.tar.gz
Algorithm Hash digest
SHA256 79db2db2cbc03f8edee2f950453842ee589081cf7e3435c6c84ec6f94c4020c2
MD5 9d53a45321ddbf86dc366c24f1fc41b4
BLAKE2b-256 74a993998a0f92e61ef9d984d4d5debbc2ad6985998cc0cb5bb0e8ba9518b0f3

See more details on using hashes here.

File details

Details for the file feedsubs-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: feedsubs-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 1.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.6.1

File hashes

Hashes for feedsubs-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 26066847640a235e04295e9cfc1c7ddc62523efbb8fedfd9068ec6ddb2f7692a
MD5 89a7a414e45664925ac388296d7c0b4e
BLAKE2b-256 6b74c7b4f457a1f057533edb64b8bf7ff59975ee81ccd5db06bc1592f8cf1109

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page