oyster/README.rst

32 lines
668 B
ReStructuredText
Raw Normal View History

2011-07-28 18:47:43 +00:00
======
oyster
======
oyster is a service for tracking regularly-accessed pages, a sort of proactive cache.
It features a daemon, a command line client for interacting with the tracking list, and a web frontend for viewing the status.
oyster was created by James Turk for `Sunlight Labs <http://sunlightlabs.com>`_.
Source is available via `GitHub <http://github.com/sunlightlabs/oyster/>`_
## ADD PyPI link after release
Installation
============
Requirements
------------
* python 2.7
* mongodb 1.8
* pymongo 1.11
* scrapelib
Usage
=====
* Run celeryd with beat ``celeryd -B --config=oyster.celeryconfig``
* Run oyster HTTP portal ``python oyster/web.py``