Metadata-Version: 2.1
Name: pali
Version: 0.0.7
Summary: A simple ThreadPool library
Home-page: https://github.com/gitvipin/pali
Author: Vipin Sharma
Author-email: sh.vipin@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown

[![Downloads](https://pepy.tech/badge/pali)](https://pepy.tech/project/pali)

# Pali

Pali is a simple Thread Pool library for Python. It is compatible with Python3 as well as Python2.

Pali can be used for:
- Creating Data Pipelines.
- Handling requests in Messaging Brokers (on the top of TCP/IP layer).
- Simulating any stress testing systems.
- API Testing systems.

Usage
------------

Pali is simple to use. Pali's Worker Pool works on tasks with well defined interface in ```pali.task.Task```.
New Tasks can be extended from it as following. ```_run``` method is important and mandatory to define as the
Thread Pool internally looks and invokes this function as start of the task.

```python
>>> from pali import worker, task
>>> class MyTask(task.Task):
...     def __init__(self, ident):
...         self.task_id = ident
...         self.done = False
...
...     def _run(self):
...         self.done = True

```

Thread Pool in itself can work either as context manager or can be invoked manually. Example below shows it's use
as context manager.

```python
# create 10 tasks
>>> tasks = [MyTask(i) for i in range(10)]

# Start a Thread Pool with 3 thread and push tasks on it.
# Tasks are processed as and when they come.
>>> with worker.ThreadPool(3) as tpool:
...     _ = [tpool.append_task(t) for t in tasks]

# Check the status of Tasks
>>> status = [t.done for t in tasks]
>>> status
[True, True, True, True, True, True, True, True, True, True]
```

Further examples can be found at https://github.com/gitvipin/Pali/tree/master/tests that reflect different ways of using ThreadPool.


Requirements
------------
Python 2.7+ and Python 3.4+

Share and enjoy!


