Permalink
Browse files

Initial README and LICENCE

  • Loading branch information...
0 parents commit 0df85412e7cf027d5cbb7116cf1cccfa355f725f @brutasse committed Sep 4, 2012
Showing with 93 additions and 0 deletions.
  1. +27 −0 LICENCE
  2. +66 −0 README.rst
27 LICENCE
@@ -0,0 +1,27 @@
+Copyright (c) 2009-2010, Bruno Renié and contributors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+
+ * Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+ * Neither the name of Bruno Renié nor the names of his contributors
+ may be used to endorse or promote products derived from this software
+ without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,66 @@
+Django-rq-dashboard
+-------------------
+
+`RQ`_ is a simple task queue for queuing and processing jobs.
+``django-rq-dashboard`` is a web frontend to monitor your RQ queues, jobs and
+workers in realtime from the Django admin. It looks like this:
+
+.. image:: http://cloud.github.com/downloads/brutasse/django-rq-dashboard/stats.png
+
+See also screenshots of the `Worker`_, `Queue`_ and `Job`_ pages.
+
+.. _Worker: http://cloud.github.com/downloads/brutasse/django-rq-dashboard/worker.png
+
+.. _Queue: http://cloud.github.com/downloads/brutasse/django-rq-dashboard/queue.png
+
+.. _Job: http://cloud.github.com/downloads/brutasse/django-rq-dashboard/job.png
+
+It is very much inspired from the Flask-powered `rq-dashboard`_.
+
+.. _RQ: http://python-rq.org/
+
+.. _rq-dashboard: https://github.com/nvie/rq-dashboard
+
+* Authors: Bruno Renié and `contributors`_
+
+ .. _contributors: https://github.com/brutasse/django-rq-dashboard/contributors
+
+* Licence: BSD
+
+* Compatibility: Django 1.4 and greater
+
+* Code & docs: https://github.com/brutasse/django-rq-dashboard
+
+Installation
+------------
+
+* ``pip install django-rq-dashboard``
+
+* Add ``django_rq_dashboard`` to your ``INSTALLED_APPS``
+
+* Add the URL patterns in you URLconf::
+
+ urlpatterns = patterns('',
+ (r'^admin/rq/', include('django_rq_dashboard.urls')),
+ # your own patterns follow…
+ )
+
+* (optional if non-default values) configure Redis access in your settings.
+ Just define a dictionnary that can be used to construct a ``Redis`` object.
+ All key are optional and their default values are::
+
+ RQ = {
+ 'host': 'localhost',
+ 'port': 6379,
+ 'db': 0,
+ 'password': None,
+ 'socket_timeout': None,
+ 'connection_pool': None,
+ 'charset': 'utf-8',
+ 'errors': 'strict',
+ 'decode_responses': False,
+ 'unix_socket_path': None,
+ }
+
+* Run the development server, queue some jobs, fire off some workers and go
+ watch http://localhost:8000/admin/rq/

0 comments on commit 0df8541

Please sign in to comment.