Initial debianization
[python_taskthread.git] / README.rst
1 TaskThread
2 ==========
3
4 Python thread module to repeat an predefined task on a thread mulitple times.
5 A TaskThread is useful when a task needs to be repeated several times on 
6 a separate thread. Normal usage of the threading.Thread class would call for
7 creation of a new thread each time the same task needs to be run. This module
8 allows for repetitive tasks to be run multiple times on the same thread by having
9 the thread wait until the task needs to be executed again.
10
11
12 Provided Classes
13 ----------------
14 ``taskthread.TaskThread```
15     A sub-class of ``threading.Thread`` that may execute a single task
16     multiple times without the overhead of starting a new thread.
17 ``taskthread.TaskInProcessException``
18     Exception that is thrown if a task is started on a thread that is
19     already executing.
20
21
22 Installation
23 ------------
24
25 *taskthread* may be installed by executing ``pip install taskthread``.
26
27
28 Links
29 -------------
30
31 * `documentation <http://taskthread.readthedocs.org/en/latest/>`_ 
32 * `source <http://github.com/hpcs-som/taskthread/>`_
33
34
35 Changes
36 -------
37
38 v1.4
39 ~~~~
40
41 * **ADD** ``TimerTask`` class that runs a repetitive task on a taskthread.
42
43
44 v1.3
45 ~~~~
46
47 * Change task loop to support python 2.6.
48
49
50 v1.2
51 ~~~~
52
53 * Refactor the module so classes are defined in __init__.py.
54
55
56 v1.1
57 ~~~~
58
59 * **ADD** ``TaskThread.join_task`` method that waits for the currently executing.
60   task to complete.
61
62
63 v1.0
64 ~~~~
65
66 * First release
67
68
69