https://github.com/dfm/ugly

The ugliest Google Reader replacement on the market
https://github.com/dfm/ugly

Last synced: about 1 year ago
JSON representation

The ugliest Google Reader replacement on the market

• Host: GitHub
• URL: https://github.com/dfm/ugly
• Owner: dfm
• License: mit
• Created: 2013-05-16T02:46:58.000Z (almost 13 years ago)
• Default Branch: main
• Last Pushed: 2020-06-12T18:27:06.000Z (almost 6 years ago)
• Last Synced: 2025-04-07T18:51:22.556Z (about 1 year ago)
• Language: Python
• Homepage: https://reader.dfm.io
• Size: 119 KB
• Stars: 6
• Watchers: 3
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
Ugly Reader

===========

*The ugliest Google Reader replacement on the market.*

Take a look at `the live demo `_ or feel free to run your own

version locally.

Installation & Setup

--------------------

First off, you'll need a Postgres server running somewhere and your web user should have

read and write access to a fresh database.

If you have a sane Python environment on your server, create a virtual environment and

then do the usual

::

    pip install -r requirements.txt

Then, you'll need to sign up as a Google OAuth app using the `Google API Console

`_ and save your client ID and secret to a Python

file with the following syntax:

::

    GOOGLE_OAUTH2_CLIENT_ID = ""

    GOOGLE_OAUTH2_CLIENT_SECRET = ""

The other options that you can set are shown in the default settings file 

``ugly/default_settings.py``. Make sure that you change your secret keys and double

check that the Postgres URI points to the right server and database. Then, to build

the needed database tables, launch Python and run (if your custom settings file is

saved as ``local.py``):

::

    from ugly import create_app

    from ugly.database import db

    from ugly.models import *

    

    db.create_all(app=create_app("local.py"))

The web app itself is built using `Flask `_ and it lives

in ``ugly/__init__.py``. For an example of how to run the app using a configuation

saved to ``local.py``, take a look at ``run_application.py``.

Finally, you'll need to run a cronjob to update the feeds and deliver any updates

to your Gmail accounts. This is implemented in the ``uglyd`` executable. You should

include the command line flag ``--config /path/to/local.py`` indicating the path of

your local settings file. I've found that running every 15 minutes seems to work

pretty well. **Log all the things.**

License

-------

Copyright 2013 `Dan Foreman-Mackey `_.

Ugly Reader is licensed under the MIT license (see LICENSE).