=========
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 editor, run:
.. code-block:: bash
wf_edit
To open a previously constructed pipeline, run:
.. code-block:: bash
wf_edit <PIPELINE.graphml>
Running workforce plan
----------------------
To run a sample plan from workforce github project:
.. code-block:: bash
wf_run example_plan.graphml
Live viewing workforce plan
---------------------------
To view a plan as it is excecuting:
.. code-block:: bash
wf_run example_plan.graphml
To run individual process(es) from the editor, 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.run import run_tasks
from workforce.view import plot_network
from workforce.edit import gui
run_tasks("<PLAN.GRAPHML>")
plot_network("<PLAN.GRAPHML>")
gui("<PLAN.GRAPHML>")
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/b8/83/eac6e07ba2524d7b8aa33ae4db6ba3e61b13f13c4996411b8cab5a41c8aa/workforce-1.0.25.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 editor, run:\n\n.. code-block:: bash\n\n wf_edit\n\nTo open a previously constructed pipeline, run:\n\n.. code-block:: bash\n\n wf_edit <PIPELINE.graphml>\n\nRunning workforce plan\n----------------------\nTo run a sample plan from workforce github project:\n\n.. code-block:: bash\n\n wf_run example_plan.graphml\n\nLive viewing workforce plan\n---------------------------\nTo view a plan as it is excecuting:\n\n.. code-block:: bash\n\n wf_run example_plan.graphml\n\nTo run individual process(es) from the editor, 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.run import run_tasks\n from workforce.view import plot_network\n from workforce.edit import gui\n run_tasks(\"<PLAN.GRAPHML>\")\n plot_network(\"<PLAN.GRAPHML>\")\n gui(\"<PLAN.GRAPHML>\")\n\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.25",
"project_urls": {
"Homepage": "https://github.com/theoportlock/workforce"
},
"split_keywords": [
"workforce"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f63a6bb358126d578bd84b3c11916bff9cb2d043fccca15ef21ffbfc135260d0",
"md5": "70d1684bcd65dd9f30d00e24fbe57fda",
"sha256": "13248d29db4645147a4f6d3eb5c8d17048eebad95eec292768a6e701cdf26a16"
},
"downloads": -1,
"filename": "workforce-1.0.25-py3-none-any.whl",
"has_sig": false,
"md5_digest": "70d1684bcd65dd9f30d00e24fbe57fda",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 11484,
"upload_time": "2025-02-10T01:02:05",
"upload_time_iso_8601": "2025-02-10T01:02:05.267479Z",
"url": "https://files.pythonhosted.org/packages/f6/3a/6bb358126d578bd84b3c11916bff9cb2d043fccca15ef21ffbfc135260d0/workforce-1.0.25-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b883eac6e07ba2524d7b8aa33ae4db6ba3e61b13f13c4996411b8cab5a41c8aa",
"md5": "ed86c2f316e36fdde353bbecf0c149b2",
"sha256": "3e987886cd3d28b95cc7d4fcd1ee699c33127a401a4d2e37ea1e0cfb9d74e1c8"
},
"downloads": -1,
"filename": "workforce-1.0.25.tar.gz",
"has_sig": false,
"md5_digest": "ed86c2f316e36fdde353bbecf0c149b2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 1683916,
"upload_time": "2025-02-10T01:02:07",
"upload_time_iso_8601": "2025-02-10T01:02:07.154939Z",
"url": "https://files.pythonhosted.org/packages/b8/83/eac6e07ba2524d7b8aa33ae4db6ba3e61b13f13c4996411b8cab5a41c8aa/workforce-1.0.25.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-10 01:02: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
