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

https://github.com/playpauseandstop/readthestuff

Read the Stuff or yet another Google Reader alternative built on top of Python
https://github.com/playpauseandstop/readthestuff

Last synced: 9 months ago
JSON representation

Read the Stuff or yet another Google Reader alternative built on top of Python

Awesome Lists containing this project

README

          

============
readthestuff
============

.. important:: Project is incomplete. Only few features working proper.
My inconvinience to WSGI Wrestle 2013 judges.

Yet another Google Reader alternative built on top of Python.

Requirements
============

* `Python `_ 2.7
* `Make `_
* `bootstrapper `_ 0.1.5 or higher
* `PostgreSQL `_ 9.3 or higher
* `ElasticSearch `_ 0.90.5 or higher
* `Redis `_ 2.6.16 or higher

License
=======

``readthestuff`` project is licensed under the terms of `BSD License
`_.

Installation
============

First of all you need to create virtual environment for project and install
all Python requirements here. This could be done in different ways, one of
which just run::

$ make bootstrap

Next, make sure you have `PostgreSQL`_, `ElasticSearch`_ and `Redis`_ installed
in your system and provide URLs for access these services in local settings
as::

DATABASE_URL = 'postgres://USERNAME:PASSWORD@HOST:PORT/DATABASE'
ELASTICSEARCH_URL = 'http://URL:9200/'
REDIS_URL = 'redis://URL:6379/'

And finally, you need to initialize PostgreSQL database. To this, just run::

$ make initdb

Now you ready to go.

Usage
=====

After installation you could run either development web-server which would be
reloading automatically on file change or Gunicorn web-server, to do this run::

$ make devserver

or::

$ make server

Also, you'll need to run RQ worker, as::

$ make rq

And finally you can check what's what by pointing browser to
``http://localhost:8321``.

Happy testing!