Metadata-Version: 2.0
Name: GrimReapersPie
Version: 0.1.0a1
Summary: Python client to the GrimReaper process killer.
Home-page: https://github.com/matee911/GrimReapersPie
Author: Mateusz Pawlik
Author-email: matee+grimreaperspie@matee.net
License: Apache 2.0
Keywords: management
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities

==============
GrimReapersPie
==============

Introduction
------------

The GrimReapersPie is an Apache2 Licensed library, written in python, to (un)register
long-running processes with the `GrimReaper`_.
Processes running longer than, the time given during the registration, will be killed
by the `GrimReaper`_ daemon.

Prerequisites
-------------

Install and run the `GrimReaper`_.


Installation
------------

To install this library, simply:

.. code-block:: bash

    $ pip install GrimReaperPie

Usage
-----

.. code-block:: python

   >>> from grimreaper import GrimReaper
   >>> grim_reaper = GrimReaper(process_timeout=5)  # set the global (default is 30s) timeout for 5 seconds
   >>> grim_reaper.register(timeout=10)  # or override the global timeout here
   # long-running job
   >>> grim_reaper.unregister()  # please, don't kill me, I had done my job before time has passed.

Contribution
------------

Please see CONTRIBUTING.rst


.. _GrimReaper: http://github.com/matee911/GrimReaper
.. _flup: https://pypi.python.org/pypi/flup/1.0.2


.. :changelog:

Release History
---------------

0.1.0a1 (2015-09-12)
+++++++++++++++++++

* Birth! Briefly tested under Python 2.7 and Python 3.4


