jobmanager/README.md
2016-09-29 15:15:59 +02:00

43 lines
1.3 KiB
Markdown

jobmanager
==========
[![PyPI](http://img.shields.io/pypi/v/jobmanager.svg)](https://pypi.python.org/pypi/jobmanager)
[![Travis](http://img.shields.io/travis/cimatosa/jobmanager.svg?label=tests)](https://travis-ci.org/cimatosa/jobmanager)
[![codecov](https://codecov.io/gh/cimatosa/jobmanager/branch/master/graph/badge.svg)](https://codecov.io/gh/cimatosa/jobmanager)
Easy distributed computing based on the python class SyncManager for remote communication and python module multiprocessing for local parallelism.
### Documentation
The documentation is available at http://cimatosa.github.io/jobmanager/
### TODO
* timeout for client
* single proxy for client and queue for subprocesses
* user signal to server to retrieve status
### known Problems
#### Python2.7
* regular shutdown takes very long -> travis tests cancel due to timeout
#### Python3.4
* some tests result in `segmentation fault (core dumped)`, nonetheless they pass
Therefore it is highly encouraged to use Python3.5 (and probably higher).
### Developer's note (out of date)
After cloning into jobmanager, create a virtual environment
virtualenv --system-site-packages ve_jm
source ve_jm/bin/activate
Install all dependencies
python setup.py develop
Running an example
python examples/simple_example.py
Running tests
python setup.py test