RSRSSR (Really Simple RSS Reader)

RSRSSR is a web-based RSS feed reader that allows users to manage and view RSS feeds, track updates, and visualize update statistics. It is built using Flask, SQLAlchemy, and Plotly. RSRSSR only supports a single user, so there is no authentication/authorization code.

Features

• Overview: The main page shows new items from each feed for the last two weeks, limited to the seven most recent items. This view strikes a balance between readability, information density and freshness.
• Manage Feeds: Add or delete RSS feeds.
• View Items: Browse through items from all feeds, with options to filter by specific feeds.
• Track Visits: Mark items as visited when clicked.
• Update Statistics: View statistics about feed updates, including the number of new items and update durations.

Data Storage

The application uses SQLite to store data. The database includes tables for feeds, items, and update statistics. SQLAlchemy is used as the ORM to interact with the database.

Running the Server Locally

1. Clone the Repository:

   git clone https://github.com/andrew-pa/rsrssr
   cd rsrssr

2. Set Up a Virtual Environment:

   python3 -m venv venv
   source venv/bin/activate

3. Install Dependencies:

   pip install -r requirements.txt

4. Initialize the Database: Ensure the instance directory exists and run the following to create the database:

   mkdir instance
   python update.py

5. Run the Server:

   python server.py

   The server will start in development mode and can be accessed at http://127.0.0.1:5000. Nothing will appear until you add some feeds in the 'Manage Feeds' page.

Working on the Code Locally

• Ensure your virtual environment is activated.
• Make changes to the codebase as needed.
• Use black to format code.

Running for Production

1. Install Gunicorn: Ensure Gunicorn is installed in your environment:

   pip install gunicorn

2. Run the Server with Gunicorn:

   gunicorn server:app

3. Run the updater:

   python update.py

   The update script needs to be run periodically to fetch new items for all feeds. It shouldn't run more than once an hour, as each time it runs it will make a request for each feed. We do attempt to correctly implement caching to prevent unnecessary load on the feed servers.

Source Code Overview

The source code is organized into several key files, each serving a specific purpose:

• server.py: This is the main entry point for the Flask application. It sets up the routes and initializes the database connection using SQLAlchemy.

• update.py: This standalone script fetches updates for all feeds. Contains functions to update RSS feeds, parse feed data, and store new items in the database. It also manages the update statistics.

• models.py: Defines the database models using SQLAlchemy ORM. It includes models for Feed, Item, and UpdateStat.

• logic.py: Implements the core logic for managing feeds, items, and update statistics. It includes functions for adding, deleting, and listing feeds, as well as recording item visits.

• stats_plot.py: Responsible for generating visualizations of update statistics using Plotly. It creates subplots to display various metrics related to feed updates.

• init.py: An empty file that marks the directory as a Python package.

• Static Files: Located in the static directory, including styles and JavaScript modules.

• Templates: HTML templates are located in the templates directory.

• Systemd Services: Example configuration files for running the webapp as a systemd service are located in the systemd directory.