Merge branch 'master' into reasonable_backoff

README.md

@@ -0,0 +1,47 @@
+[![Build Status](https://travis-ci.org/mikemill/rq_retry_scheduler.svg?branch=master)](https://travis-ci.org/mikemill/rq_retry_scheduler)
+[![Coverage Status](https://coveralls.io/repos/github/mikemill/rq_retry_scheduler/badge.svg?branch=master)](https://coveralls.io/github/mikemill/rq_retry_scheduler?branch=master)
+
+# RQ Retry Scheduler
+
+[RQ Retry Scheduler](https://github.com/mikemill/rq_retry_scheduler) extends the RQ worker class to provide functionality to enqueue jobs based on time.
+
+Additionally, it provides a worker that will automatically retry failed jobs using a backoff scheme.
+
+# Usage
+
+## Queues
+
+The `rq_retry_scheduler.Queue` class can be used as a drop in replacement for `rq.Queue`.  It provides two additional enqueuing methods:
+
+* `enqueue_at` - Enqueue the job at the specified time.  The time should be a `datetime.datetime` object with the UTC timezone.
+* `enqueue_in` - Enqueue the job after the specified amount of time.  The time should be a `datetime.timedelta` object.
+
+Additionally, two other methods are available `enqueue_job_at` and `enqueue_job_in` which work like the above methods but take a `rq.Job` object as the paramter.
+
+## Scheduler
+
+In order to move jobs from the schedule queue into the proper RQ queue a scheduler needs to be ran.
+This can be accomplished via the `rqscheduler` script.  Additionally, you can extend from `rq_retry_scheduler.Scheduler` to customize the functonality.
+
+## Worker
+
+A worker is provided that will requeue jobs that fail using a defiend backoff strategy.
+The worker is designed to use the functionality from the `Queue` class to control the backoff.
+
+The worker can be used by using the `-w` option to `rq worker`: `rq worker -w 'rq_rety_scheduler.Worker`.
+
+The backoff times and total attempts is controlled by `Worker.retry_delays`.
+
+
+# Installation
+
+Install via pip
+
+```
+pip install rq-retry-scheduler
+```
+
+
+# Acknowledgements
+
+This package was based heavily on the work of [RQ Scheduler](https://github.com/ui/rq-scheduler).

setup.py

@@ -1,12 +1,22 @@
 from setuptools import setup, find_packages
 
+try:
+    import pypandoc
+
+    def long_description():
+        return pypandoc.convert_file('README.md', 'rst')
+
+except ImportError:
+    def long_description():
+        return ''
+
 
 setup(
     name='rq-retry-scheduler',
     version='0.1.0b1',
     url='https://github.com/mikemill/rq_retry_scheduler',
     description='RQ Retry and Scheduler',
-    long_description=open('README.rst').read(),
+    long_description=long_description(),
     author='Michael Miller',
     author_email='mikemill@gmail.com',
     packages=find_packages(exclude=['*tests*']),