Metadata-Version: 1.2
Name: workforce
Version: 0.0.5
Summary: Run bash commands with python multiprocessing according to a csv file edgelist.
Home-page: https://github.com/theoportlock/workforce
Author: Theo Portlock
Author-email: zn.tportlock@gmail.com
License: MIT license
Description: =========
        workforce
        =========
        
        
        .. image:: https://img.shields.io/pypi/v/workforce.svg
                :target: https://pypi.python.org/pypi/workforce
        
        .. image:: https://img.shields.io/travis/theoportlock/workforce.svg
                :target: https://travis-ci.com/theoportlock/workforce
        
        .. image:: https://readthedocs.org/projects/workforce/badge/?version=latest
                :target: https://workforce.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        
        
        
        Run bash commands with python multiprocessing according to a csv file edgelist.
        
        
        * Free software: MIT license
        * Documentation: https://workforce.readthedocs.io.
        
        
        Features
        --------
        Installation can be done with 
        
        `pip install workforce`
        
        To try a sample plan, run with:
        
        `python workforce.py example_plan.csv`
        
        To view the program graph, networkx and matplotlib are required. The -g flag is required to produce a dot file of the network:
        
        `python3 workforce.py -g example_plan.csv`
        
        Converting the graph to a dot can be done using an online dot viewer or using Graphviz software with the example command:
        
        `dot -Tpng -Kdot -o <DOT_FILENAME>.png <DOT_FILENAME>`
        
        .. image:: example_plan.png
        
        The schema should be in the format of a csv with two columns. On the left and right column is the source and target command respectively (see example). Produces a logfile for each run.
        
        The following bashrc alias is recommended if this repository is in your home directory:
        
        `alias wf="python ~/workforce/workforce.py"`
        
        Testing can be done within this directory by running:
        `python -m unittest -v`
        
        Credits
        -------
        
        This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        
        =======
        History
        =======
        
        0.1.0 (2021-01-16)
        ------------------
        
        * First release on PyPI.
        
Keywords: workforce
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5
