Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/passiomatic/coldsweat

Web RSS aggregator and reader compatible with the Fever API
https://github.com/passiomatic/coldsweat

fever-api python rss

Last synced: 4 days ago
JSON representation

Web RSS aggregator and reader compatible with the Fever API

Awesome Lists containing this project

README 

        
# Coldsweat



Coldsweat is a self-hosted Python 3 web RSS aggregator and reader compatible with the [Fever API][f]. This means that you can connect Coldsweat to a variety of clients like [Reeder][r] for iOS or Mac OS X [ReadKit][rk] app and use it to sync them together.



![Screenshot](https://lab.passiomatic.com/coldsweat/images/coldsweat-0.9.6-screenshot.jpg)



## Features



* Web interface to read and add feeds

* Compatible with existing Fever desktop and mobile clients

* Multi-user support

* Basic support for grouping of similar items



## Installation and quick setup



Let's see how you can take a peek at what Coldsweat offers running it on your machine.



**Note**: you can install Coldsweat in the main Python environment of your machine or in a virtual environment, which is the recommended approach, since its dependencies may clash with packages you have already installed. [Learn more about virtual environments here][venv]. 



### Install



Coldsweat is [Flask application][flask] distributed as a Python wheel, hence you can install it from PyPI using the, hopefully familiar, `pip` utility:



    $ pip install coldsweat



The install procedure will also create a `coldsweat` command, available in your terminal.



### Create a user



Once installed, create a new user specifing email and password with the `setup` command:



    $ coldsweat setup [email protected] -p somepassword



If you prefer you can enter the password interactively:



    $ coldsweat setup [email protected]  

    Enter password for user [email protected]: ************

    Enter password (again): ************

    Setup completed for [email protected]



Email and password will be needed to access the web UI and use the Fever API sync with your favourite RSS client.



### Import your feeds



Like other RSS software Coldsweat uses the OPML format to import multiple feeds with a single operation:



    $ coldsweat import /path/to/subscriptions.opml [email protected] -f



The `-f` option tells Coldsweat to fetch the feeds right after the import step.



### Fetch feeds



To update all the feeds run the `fetch` command:



    $ coldsweat fetch 



You should use `cron` or similar utilities to schedule feed fetches periodically.



### Run the web UI



Then you can run the Flask development web server and access the web UI: 



    $ coldsweat run 

    * Serving Flask app 'coldsweat'

    * Debug mode: off

    * Running on http://127.0.0.1:5000

    ...



See [Setup] and [Deploy] pages for additional information.



## Upgrading from a previous version



Upgrade to the latest Coldsweat version with:



    $ pip install -U coldsweat



**Note**: there's no upgrade path from previous 0.9.x releases. Your best bet if to export OPML subscriptions and import them in the new 0.10 release.    



## Contributing



See [Contributing] page.



## 0.10 technical underpinnings



* Runs on Python 3.9 and up

* Completely rebuilt using Flask web framework

* Supports SQLite, PostgreSQL, and MySQL databases

* [HTTP-friendly fetcher][ff]

* Tested with latest versions of Chrome, Safari, and Firefox



## Motivation



I'm fed up of online services that are here today and gone tomorrow. Years ago, after the Google Reader shutdown it was clear to me that the less we rely on external services the more the data we care about are preserved. With this in mind I'm writing Coldsweat. It is my personal take at consuming feeds today.



Coldsweat started in July 2013 as a fork of [Bottle Fever][b] by Rui Carmo. After several years of pause I've restarted to develop Coldsweat using Python 3 and the latest crop of web technologies.



[fp]: https://pypi.python.org/pypi/feedparser/

[f]: http://www.feedafever.com/

[s]: https://github.com/passiomatic/coldsweat

[b]: https://github.com/rcarmo/bottle-fever

[rk]: https://readkitapp.com/

[r]: https://reederapp.com/

[ff]: https://github.com/passiomatic/coldsweat/wiki/Fetcher-features

[Setup]: https://github.com/passiomatic/coldsweat/wiki/Setup

[Deploy]: https://github.com/passiomatic/coldsweat/wiki/Deploy

[Contributing]: https://github.com/passiomatic/coldsweat/wiki/Contributing

[venv]: https://docs.python.org/3/library/venv.html

[flask]: https://flask.palletsprojects.com/en/2.3.x/

[disco]: https://flask.palletsprojects.com/en/2.3.x/cli/#application-discovery