Skip to content

Commit

Permalink
Add standard distribution files
Browse files Browse the repository at this point in the history
  • Loading branch information
Ask Solem committed Dec 7, 2009
1 parent 3d8e982 commit 9318952
Show file tree
Hide file tree
Showing 8 changed files with 178 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.DS_Store
*.pyc
*~
.*.sw[po]
dist/
*.egg-info
doc/__build/*
build/
.build/
pip-log.txt
.directory
2 changes: 2 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Ordered by date of first contribution:
Ask Solem <askh@opera.com>
8 changes: 8 additions & 0 deletions Changelog
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
==============
Change history
==============

0.1.0 [xxxx-xx-xx xx:xx x.x xxx]
================================

* Initial release.
28 changes: 28 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Copyright (c) 2009, Ask Solem
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 Ask Solem nor the names of its 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 OWNER 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.

9 changes: 9 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
include AUTHORS
include Changelog
include README.rst
include MANIFEST.in
include LICENSE
include TODO
recursive-include celerymon *.py
prune celerymon/*.pyc
prune bin/*.pyc
1 change: 1 addition & 0 deletions README
117 changes: 117 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
====================================================
celerymon - Real-time monitoring of Celery workers
====================================================

:Version: 0.1.0

Introduction
============

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

You can install ``celerymon`` either via the Python Package Index (PyPI)
or from source.

To install using ``pip``,::

$ pip install celerymon

To install using ``easy_install``,::

$ easy_install celerymon

Downloading and installing from source
--------------------------------------

Download the latest version of ``celerymon`` from
http://pypi.python.org/pypi/celerymon/

You can install it by doing the following,::

$ tar xvfz celerymon-0.0.0.tar.gz
$ cd celerymon-0.0.0
$ python setup.py build
# python setup.py install # as root

Using the development version
------------------------------

You can clone the repository by doing the following::

$ git clone git://github.com/ask/celerymon.git


Usage
=====

Running the monitor
-------------------

Start celery with the ``--events`` option on, so celery sends events for
celerymon to capture::

$ python manage.py celeryd -E

Run the monitor server::

$ python manage.py celerymon


However, in production you probably want to run the monitor in the
background, as a daemon::

$ python manage.py celerymon --detach


For a complete listing of the command line arguments available, with a short
description, you can use the help command::

$ python manage.py help celerymon


Now you can visit the webserver celerymon starts by going to:
http://localhost:8989


Mailing list
------------

For discussions about the usage, development, and future of celery,
please join the `celery-users`_ mailing list.

.. _`celery-users`: http://groups.google.com/group/celery-users/

IRC
---

Come chat with us on IRC. The `#celery`_ channel is located at the `Freenode`_
network.

.. _`#celery`: irc://irc.freenode.net/celery
.. _`Freenode`: http://freenode.net


Bug tracker
===========

If you have any suggestions, bug reports or annoyances please report them
to our issue tracker at http://github.com/ask/celerymon/issues/

Contributing
============

Development of ``celerymon`` happens at Github:
http://github.com/ask/celerymon

You are highly encouraged to participate in the development
of ``celerymon``. If you don't like Github (for some reason) you're welcome
to send regular patches.

License
=======

This software is licensed under the ``New BSD License``. See the ``LICENSE``
file in the top distribution directory for the full license text.

.. # vim: syntax=rst expandtab tabstop=4 shiftwidth=4 shiftround
2 changes: 2 additions & 0 deletions TODO
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Please see our Issue Tracker at GitHub:
http://github.com/ask/celerymon/issues

0 comments on commit 9318952

Please sign in to comment.