Metadata-Version: 2.1
Name: workforce
Version: 1.0.7
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
Keywords: workforce
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
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: networkx
Requires-Dist: pydot
Requires-Dist: dash-cytoscape
Requires-Dist: dash
Requires-Dist: pandas
Requires-Dist: matplotlib
Requires-Dist: openpyxl

=========
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.


Installation
------------
Installation can be done with 

.. code-block:: bash

   pip install workforce

Building a workforce workflow
-----------------------------
To build a workflow, simply run:

.. code-block:: bash

   workforce

Then, paste the IP address into into your browsers address bar and build your program.

Running workforce
-----------------
To run a sample plan from workforce github project:

.. code-block:: bash

   workforce example_plan.csv

To import and use in a python shell, use the following command:

.. code-block:: python

   from workforce.workforce import worker
   steve = worker("<PLAN.CSV>")
   steve.run()

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.

Testing
-------
Testing can be done within the github directory by running:

.. code-block:: bash

   python -m unittest -v


=======
History
=======

0.1.0 (2021-01-16)
------------------

* First release on PyPI.
