Giter VIP home page Giter VIP logo

coldsweat's Introduction

About

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

Screenshot

Motivation

I'm fed up of online services that are here today and gone tomorrow. After the Google Reader shutdown is 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 will be my personal take at consuming feeds today.

Features

  • Web interface to read and add feeds
  • Compatible with existing Fever desktop and mobile clients
  • Multi-user support
  • Support for grouping of similar items
  • Multiprocessing for parallel feed fetching

Setup

See setup page.

Upgrading from a previous version

First, always make sure required third-party packages are up-to-date:

$ pip install -r requirements.txt

Second, make sure your database structure is up-to-date too:

$ python sweat.py upgrade

Backwards-incompatible changes in 0.9.5

Configuration

A few changes have been made to the configuration options:

  • A new config option named connection_url replaces engine, database, hostname, username and password options
  • Config option error_threshold is now called max_errors
  • Config option multiprocessing has been replaced by processes. Assigning a value of 0 disables multiprocessing
  • Log config options format and datefmt have been removed. Please remove them from your etc/config file if Coldsweat raises a ConfigParser.InterpolationMissingOptionError exception on startup.

To make the configuration code more robust almost all options have now a default value so you don't necessary need to adjust the values listed above. Take a look at etc/config-sample for further information.

Fever sync

Coldsweat now uses the user e-mail instead of username to authorize clients, like Fever API dictates. This means that while configuring your Fever client it is required to specify an e-mail address and password to successully finish to authorization process.

New commands names

The commands update and refresh are now respectively aliases of upgrade and fetch. Older command names will most likely dropped with the 1.0.0 release.

Technical underpinnings

  • Uses the industry standard Mark Pilgrim's Universal Feed Parser
  • Is WSGI compatible - currently tested under CGI, FastCGI and Passenger environments
  • Uses SQLite, PostgreSQL and MySQL databases
  • HTTP-friendly fetcher
  • Plugin system to easily extend fetcher capabilities
  • The Web reader has been tested with Safari 5+ and latest versions of Chrome and Firefox

Coldsweat started in July 2013 as a fork of Bottle Fever by Rui Carmo. By now I revised most of the code and tested the feed fetcher code with hundreds of Atom and RSS feeds.

coldsweat's People

Contributors

dontneedgithubaccount avatar passiomatic avatar tewe avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.