Metadata-Version: 2.1
Name: workforce
Version: 1.0.15
Summary: Run bash commands with python multiprocessing according to a tsv 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
Requires-Dist: filelock

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


Build and run a pipeline of bash commands with python multiprocessing according to a tsv 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 launch the pipeline builder, run:

.. code-block:: bash

   workforce

To open a previously constructed pipeline, run:

.. code-block:: bash

   workforce <PIPELINE.tsv>

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

.. code-block:: bash

   workforce -r example_plan.tsv

To run individual process(es) from the builder, select the process(es) in the order that you wish them to be excecuted and click the 'Run' button. The command line from where the builder was launched will display the standard output and error for each process.

Deleting processes from the project can be done by selecting a process and clicking the 'Delete' button

The simplest way to edit a process is to click the edge that the process is connected to. This will fill the 'Input' box with the connection details. You can then add a new node with those connections and delete the old process.

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

.. code-block:: python

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

The schema should be in the format of a tsv with two columns. On the left and right column is the source and target process respectively (see example).

This is tested on mac and linux but requires work for windows integration except for wsl2


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

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

* First release on PyPI.
