summaryrefslogtreecommitdiff
path: root/docs/index.rst
blob: d52b8084cb529069832c515a972159979f3f5c7c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
.. taskthread documentation master file, created by
   sphinx-quickstart on Wed Dec  4 15:35:14 2013.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to taskthread's documentation!
======================================

*taskthread* provides a thread implementation that executes a repetitive
task several times without the need to start up a new thread.

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

*taskthread* can be installed with pip, via ``pip install taskthread``.

Usage
-----

TaskThread
~~~~~~~~~~
.. autoclass:: taskthread.TaskThread
    :members:

TaskInProcessException
~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: taskthread.TaskInProcessException
    :members:

TimerThread
~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: taskthread.TimerTask
    :members: