| Name | run-para JSON |
| Version |
1.2.8
JSON |
| download |
| home_page | https://github.com/joknarf/run-para |
| Summary | Interactive Parallel SSH jobs manager |
| upload_time | 2025-09-07 22:48:12 |
| maintainer | Franck Jouvanceau |
| docs_url | None |
| author | Franck Jouvanceau |
| requires_python | >=3.6 |
| license | MIT License
Copyright (c) 2024 joknarf
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
|
| keywords |
run
command
cli
parallel
jobs
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://joknarf.github.io/joknarf-tools)
[](https://pypi.org/project/run-para/)
[](https://github.com/joknarf/run-para/actions)
[](https://shields.io/)
[](https://pepy.tech/project/run-para)
[](https://shields.io/)
[]()
# run-para
Parallel jobs manager CLI
* POSIX/Linux/MacOS/Windows compatible
* Launch parallel command and maps list of params to command, with interactive display of the running commands outputs
* Keep all output in log files
* Interactive pause/resume/abort jobs, kill stuck command interactively.
Take a look at [ssh-para](https://github.com/joknarf/ssh-para) if you need parallel ssh jobs to multiple servers
## installation
```shell
pip install run-para
```
By default, `run-para` uses Nerd Fonts glyphs, modern terminals can now render the glyphs without installing specific font (the symbols can be overridden with SSHP_SYM_* environment variables, see below)
## quick start
```
Run parallel commands:
$ run-para -P host1 host2 host3 -- ssh -n @1 "echo @1 is reachable"
TUI to consult last run logs
$ run-para -T
Review last runs results:
$ run-para -l
Review hosts statuses for last run:
$ run-para -L *.status
View failed hosts list:
$ run-para -L failed.status
Show output of command on all hosts:
$ run-para -L *.out
Show output of command for failed hosts:
$ run-para -L *.failed
Show output of command for host1:
$ run-para -L host1.out
```
## params mapping to command
run-para will match parameters to the command according to `@x` mapping.
using -P options, can only pass 1 parameter to command
using -f paramsfile, can pass multiple parameters
example:
```shell
run-para -P param1 param2 -- echo @1
```
will launch:
```shell
echo param1
echo param2
```
```shell
run-para -f params.txt -- curl -OL "http://@1/download/@2"
params.txt:
server1 "the file1.zip"
server2 "the file2.zip"
```
will launch:
```shell
curl -OL "http://server1/download/the file1.zip"
curl -OL "http://server2/download/the file2.zip"
```
## usage
```
run-para -h
```
```
usage: run-para [-h] [-V] [-j JOB] [-d DIRLOG] [-p PARALLEL] [-t TIMEOUT] [-v] [-D DELAY]
[-f PARAMSFILE | -P PARAM [PARAM ...] | -l | -L LOGS [LOGS ...]]
[command ...]
run-para v1.run-para.dev
positional arguments:
command
options:
-h, --help show this help message and exit
-V, --version run-para version
-j JOB, --job JOB Job name added subdir to dirlog
-d DIRLOG, --dirlog DIRLOG
directory for ouput log files (default: ~/.run-para)
-m MAXWIDTH, --maxwidth MAXWIDTH
max width to use to display params
-p PARALLEL, --parallel PARALLEL
parallelism (default 4)
-t TIMEOUT, --timeout TIMEOUT
timeout of each job
-v, --verbose verbose display (param + line for last output)
-n, --nopause exit at end of run (no pause for keypress)
-D DELAY, --delay DELAY
initial delay in seconds between ssh commands (default=0.3s)
-f PARAMSFILE, --paramsfile PARAMSFILE
params list file
-P PARAM [PARAM ...], --params PARAM [PARAM ...]
hosts list
-C {bash,zsh,powershell}, --completion {bash,zsh,powershell}
autocompletion shell code to source
-l, --list list run-para results/log directories
-L LOGS [LOGS ...], --logs LOGS [LOGS ...]
get latest/current run-para run logs
-L[<runid>/]*.out : all hosts outputs
-L[<runid>/]<host>.out : command output of host
-L[<runid>/]*.<status> : command output of hosts <status>
-L[<runid>/]*.status : hosts lists with status
-L[<runid>/]<status>.status: <status> hosts list
-L[<runid>/]params.list : list of parms used to map command
default <runid> is latest run-para run (use -j <job> -d <dir> to access logs if used for run)
<status>: [success,failed,timeout,killed,aborted]
```
During run, use :
* k: to kill command held by a thread
* p: pause all remaining jobs to be scheduled
* r: resume scheduling of jobs
* a: abort all remaining jobs
* ctrl-c: stop all/exit
Environment variables:
* SSHP_SYM_BEG: Symbol character for begin decorative (default: "\ue0b4")
* SSHP_SYM_END: Symbol character for end decorative (default: "\ue0b6")
* SSHP_SYM_PROG: Symbol character for progress bar fill (default: "\u25a0")
* SSHP_SYM_RES: Symbol character before ssh output line (default: "\u25b6")
Activate autocompletion:
* `. <(run-para -C bash)`
* `run-para -C powershell | Out-String | Invoke-Expression`
Raw data
{
"_id": null,
"home_page": "https://github.com/joknarf/run-para",
"name": "run-para",
"maintainer": "Franck Jouvanceau",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "run, command, cli, parallel, jobs",
"author": "Franck Jouvanceau",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/0e/f0/0f3fe5c6b13dfdaf2a25ef52d12e4827ab9deca27894f4261cf2dea035c6/run_para-1.2.8.tar.gz",
"platform": null,
"description": "[](https://joknarf.github.io/joknarf-tools)\n[](https://pypi.org/project/run-para/)\n[](https://github.com/joknarf/run-para/actions)\n[](https://shields.io/)\n[](https://pepy.tech/project/run-para)\n[](https://shields.io/)\n[]()\n\n\n\n# run-para\n\nParallel jobs manager CLI\n\n* POSIX/Linux/MacOS/Windows compatible\n* Launch parallel command and maps list of params to command, with interactive display of the running commands outputs\n* Keep all output in log files\n* Interactive pause/resume/abort jobs, kill stuck command interactively.\n\nTake a look at [ssh-para](https://github.com/joknarf/ssh-para) if you need parallel ssh jobs to multiple servers\n\n\n\n\n## installation\n```shell\npip install run-para\n```\nBy default, `run-para` uses Nerd Fonts glyphs, modern terminals can now render the glyphs without installing specific font (the symbols can be overridden with SSHP_SYM_* environment variables, see below)\n\n## quick start\n\n```\nRun parallel commands:\n$ run-para -P host1 host2 host3 -- ssh -n @1 \"echo @1 is reachable\"\nTUI to consult last run logs\n$ run-para -T\nReview last runs results:\n$ run-para -l\nReview hosts statuses for last run:\n$ run-para -L *.status\nView failed hosts list:\n$ run-para -L failed.status\nShow output of command on all hosts:\n$ run-para -L *.out\nShow output of command for failed hosts:\n$ run-para -L *.failed\nShow output of command for host1:\n$ run-para -L host1.out\n```\n\n## params mapping to command\n\nrun-para will match parameters to the command according to `@x` mapping. \nusing -P options, can only pass 1 parameter to command \nusing -f paramsfile, can pass multiple parameters \n\nexample:\n```shell\nrun-para -P param1 param2 -- echo @1\n```\nwill launch:\n```shell\necho param1\necho param2\n```\n```shell\nrun-para -f params.txt -- curl -OL \"http://@1/download/@2\"\nparams.txt:\nserver1 \"the file1.zip\"\nserver2 \"the file2.zip\"\n```\nwill launch:\n```shell\ncurl -OL \"http://server1/download/the file1.zip\"\ncurl -OL \"http://server2/download/the file2.zip\"\n```\n\n## usage\n```\nrun-para -h\n```\n```\nusage: run-para [-h] [-V] [-j JOB] [-d DIRLOG] [-p PARALLEL] [-t TIMEOUT] [-v] [-D DELAY]\n [-f PARAMSFILE | -P PARAM [PARAM ...] | -l | -L LOGS [LOGS ...]]\n [command ...]\n\nrun-para v1.run-para.dev\n\npositional arguments:\n command\n\noptions:\n -h, --help show this help message and exit\n -V, --version run-para version\n -j JOB, --job JOB Job name added subdir to dirlog\n -d DIRLOG, --dirlog DIRLOG\n directory for ouput log files (default: ~/.run-para)\n -m MAXWIDTH, --maxwidth MAXWIDTH\n max width to use to display params\n -p PARALLEL, --parallel PARALLEL\n parallelism (default 4)\n -t TIMEOUT, --timeout TIMEOUT\n timeout of each job\n -v, --verbose verbose display (param + line for last output)\n -n, --nopause exit at end of run (no pause for keypress)\n -D DELAY, --delay DELAY\n initial delay in seconds between ssh commands (default=0.3s)\n -f PARAMSFILE, --paramsfile PARAMSFILE\n params list file\n -P PARAM [PARAM ...], --params PARAM [PARAM ...]\n hosts list\n -C {bash,zsh,powershell}, --completion {bash,zsh,powershell}\n autocompletion shell code to source\n -l, --list list run-para results/log directories\n -L LOGS [LOGS ...], --logs LOGS [LOGS ...]\n get latest/current run-para run logs\n -L[<runid>/]*.out : all hosts outputs\n -L[<runid>/]<host>.out : command output of host\n -L[<runid>/]*.<status> : command output of hosts <status>\n -L[<runid>/]*.status : hosts lists with status\n -L[<runid>/]<status>.status: <status> hosts list\n -L[<runid>/]params.list : list of parms used to map command\n default <runid> is latest run-para run (use -j <job> -d <dir> to access logs if used for run)\n <status>: [success,failed,timeout,killed,aborted]\n``` \nDuring run, use :\n\n* k: to kill command held by a thread\n* p: pause all remaining jobs to be scheduled\n* r: resume scheduling of jobs\n* a: abort all remaining jobs\n* ctrl-c: stop all/exit \n\nEnvironment variables:\n\n* SSHP_SYM_BEG: Symbol character for begin decorative (default: \"\\ue0b4\")\n* SSHP_SYM_END: Symbol character for end decorative (default: \"\\ue0b6\")\n* SSHP_SYM_PROG: Symbol character for progress bar fill (default: \"\\u25a0\")\n* SSHP_SYM_RES: Symbol character before ssh output line (default: \"\\u25b6\")\n\nActivate autocompletion:\n\n* `. <(run-para -C bash)`\n* `run-para -C powershell | Out-String | Invoke-Expression`\n\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2024 joknarf\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "Interactive Parallel SSH jobs manager",
"version": "1.2.8",
"project_urls": {
"Documentation": "https://github.com/joknarf/run-para/blob/main/README.md",
"Homepage": "https://joknarf.github.io/joknarf-tools/",
"Repository": "https://github.com/joknarf/run-para.git"
},
"split_keywords": [
"run",
" command",
" cli",
" parallel",
" jobs"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c0d445517c859d16279921393f6c1c824f7fcdc89d065a2f254b151d04f98c24",
"md5": "172950eaf8dc62b8548fe8f9814bb082",
"sha256": "ddd09cec3cee09229de2acdff449368bac919b20c8f820f59ec7748f779a3a04"
},
"downloads": -1,
"filename": "run_para-1.2.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "172950eaf8dc62b8548fe8f9814bb082",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 31668,
"upload_time": "2025-09-07T22:48:10",
"upload_time_iso_8601": "2025-09-07T22:48:10.471293Z",
"url": "https://files.pythonhosted.org/packages/c0/d4/45517c859d16279921393f6c1c824f7fcdc89d065a2f254b151d04f98c24/run_para-1.2.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "0ef00f3fe5c6b13dfdaf2a25ef52d12e4827ab9deca27894f4261cf2dea035c6",
"md5": "76893898d6a1fdb7c9f62bfb549146d1",
"sha256": "c551382fecfb3c9517a1ea986abba558e43bbd3bc3dbbaec6128517ccb55461c"
},
"downloads": -1,
"filename": "run_para-1.2.8.tar.gz",
"has_sig": false,
"md5_digest": "76893898d6a1fdb7c9f62bfb549146d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 33424,
"upload_time": "2025-09-07T22:48:12",
"upload_time_iso_8601": "2025-09-07T22:48:12.029633Z",
"url": "https://files.pythonhosted.org/packages/0e/f0/0f3fe5c6b13dfdaf2a25ef52d12e4827ab9deca27894f4261cf2dea035c6/run_para-1.2.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-07 22:48:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "joknarf",
"github_project": "run-para",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "run-para"
}
