=========
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/theoportlock/workforce",
"name": "workforce",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": null,
"keywords": "workforce",
"author": "Theo Portlock",
"author_email": "zn.tportlock@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e1/8b/70540f3beadd4838860cc8eacfbd812eee3ddec55e836b7525de43062f13/workforce-1.0.20.tar.gz",
"platform": null,
"description": "=========\nworkforce\n=========\n\n\n.. image:: https://img.shields.io/pypi/v/workforce.svg\n :target: https://pypi.python.org/pypi/workforce\n\n.. image:: https://img.shields.io/travis/theoportlock/workforce.svg\n :target: https://travis-ci.com/theoportlock/workforce\n\n.. image:: https://readthedocs.org/projects/workforce/badge/?version=latest\n :target: https://workforce.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n\nBuild and run a pipeline of bash commands with python multiprocessing according to a tsv file edgelist.\n\n* Free software: MIT license\n* Documentation: https://workforce.readthedocs.io.\n\n\nInstallation\n------------\nInstallation can be done with:\n\n.. code-block:: bash\n\n pip install workforce\n\nBuilding a workforce workflow\n-----------------------------\nTo launch the pipeline builder, run:\n\n.. code-block:: bash\n\n workforce\n\nTo open a previously constructed pipeline, run:\n\n.. code-block:: bash\n\n workforce <PIPELINE.tsv>\n\nRunning workforce\n-----------------\nTo run a sample plan from workforce github project:\n\n.. code-block:: bash\n\n workforce -r example_plan.tsv\n\nTo 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.\n\nDeleting processes from the project can be done by selecting a process and clicking the 'Delete' button\n\nThe 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.\n\nTo import and use in a python shell, use the following command:\n\n.. code-block:: python\n\n from workforce.workforce import worker\n worker(\"<PLAN.CSV>\")\n\nThe 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).\n\nThis is tested on mac and linux but requires work for windows integration except for wsl2\n\n\n=======\nHistory\n=======\n\n0.1.0 (2021-01-16)\n------------------\n\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "Run bash commands with python multiprocessing according to a tsv file edgelist.",
"version": "1.0.20",
"project_urls": {
"Homepage": "https://github.com/theoportlock/workforce"
},
"split_keywords": [
"workforce"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fb751478a874c599aa7adc9ea1c7fcee50493917d2d11dcf8b9e92fd5554a83a",
"md5": "56eaf556699aeff363b7beeb39de4cbe",
"sha256": "f06eabe344d86aae2d2b381abf66b9698d5cff5701c1f9a2a31b1661fa30288e"
},
"downloads": -1,
"filename": "workforce-1.0.20-py3-none-any.whl",
"has_sig": false,
"md5_digest": "56eaf556699aeff363b7beeb39de4cbe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 7620,
"upload_time": "2024-10-31T09:13:05",
"upload_time_iso_8601": "2024-10-31T09:13:05.438455Z",
"url": "https://files.pythonhosted.org/packages/fb/75/1478a874c599aa7adc9ea1c7fcee50493917d2d11dcf8b9e92fd5554a83a/workforce-1.0.20-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e18b70540f3beadd4838860cc8eacfbd812eee3ddec55e836b7525de43062f13",
"md5": "7422e284b2ac4297bee6fe76c859bd8c",
"sha256": "1cb22bf94acc269e3e1ddfec4f9dd910920f39c8b11efeeb086e5af1e26b97b0"
},
"downloads": -1,
"filename": "workforce-1.0.20.tar.gz",
"has_sig": false,
"md5_digest": "7422e284b2ac4297bee6fe76c859bd8c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 1681011,
"upload_time": "2024-10-31T09:13:07",
"upload_time_iso_8601": "2024-10-31T09:13:07.203416Z",
"url": "https://files.pythonhosted.org/packages/e1/8b/70540f3beadd4838860cc8eacfbd812eee3ddec55e836b7525de43062f13/workforce-1.0.20.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-31 09:13:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "theoportlock",
"github_project": "workforce",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "workforce"
}
JSON
