| Name | pmflow JSON |
| Version |
1.2.15
JSON |
| download |
| home_page | None |
| Summary | Manages processes |
| upload_time | 2024-11-17 12:17:52 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2024 Md. Mahmudul Hasan Riyad 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 |
process manager
process
pm
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PMFlow
<p style="font-size:15px;">This is a simple process managing command line tool</p>
<p style="font-size:15px;">This tools keeps the information of the processes it manages in a json file created at it's installation location</p>
## Installation
```
pip install pmflow
```
Windows Installation: After installing pmflow with pip on windows make sure the path where the pm script is in the environment variable.
Use the below command in cmd to see the installation location of the pmflow
```
pip show pmflow
```
It should be something like ```C:\your\installation\location\Python\Python3<version>\site-packages```. In ```Python3<version>``` directory there should be a directory
named ```scripts```. Make sure the path ```C:\your\installation\location\Python\Python3<version>\scripts``` is a environment variable and you should be good to go.
## Commands
### <^> Main commands
create: Creates a new process
Required arguments:
- command: str (default: None)
Optional arguments:
- --name or -n : str (default: None)
- --group or -g : str (default: process_id)
- --relation or -r : "parent" | "child" (default: "parent")
- --verbose or -v: (default: false)
Note: A child process must have a group name and the group must have a parent process.
Example:
```
pm create "<command>"
or
pm create "<command>" -n "<process name>" -g "<group name>" -r "child"
```
ls: List all managed processes
Optional arguments:
- --json or -j: bool (default: false)
- --group or -g: str (default: None)
- --running or -r: bool (default: false)
Example:
```
pm ls
pm ls -j
pm ls -g <group_name>
pm ls -j -g <group_name>
pm ls -r
```
kill: Kill process, kills the process and also removes it from the json file.
Optional arguments:
- pid (no flag needed): int (default: 0) kills one process if it's a child process. Otherwise, kills the terminates
- --group or -g: str (default: None) kills one group if exist
- --child or -c: bool (default: False) kills all child process in a group
- --all or -a : bool (default: false) kills all the process
Note: Other than -c only one options can be used at a time. -c flag must be used with -g
Example:
```
pm kill <PID>
pm kill -g <group_name>
pm kill -g <group_name> -c
pm kill -a
```
### <^> Additional commands
Recreate all process managed by the tool:
```
pm recreate
```
Pause a process
```
pm pause <PID>
```
respawn all paused process
```
pm respawn
```
Raw data
{
"_id": null,
"home_page": null,
"name": "pmflow",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "process manager, process, pm",
"author": null,
"author_email": "\"Md. Mahmudul Hasan Riyad\" <mhriyad98@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/9d/b9/9345a50447633493ebba799d15f14f173640a3aae1ffde16a2a7b35ee978/pmflow-1.2.15.tar.gz",
"platform": null,
"description": "# PMFlow\n<p style=\"font-size:15px;\">This is a simple process managing command line tool</p>\n\n<p style=\"font-size:15px;\">This tools keeps the information of the processes it manages in a json file created at it's installation location</p>\n\n## Installation\n```\npip install pmflow\n```\nWindows Installation: After installing pmflow with pip on windows make sure the path where the pm script is in the environment variable.\n\nUse the below command in cmd to see the installation location of the pmflow\n```\npip show pmflow\n```\nIt should be something like ```C:\\your\\installation\\location\\Python\\Python3<version>\\site-packages```. In ```Python3<version>``` directory there should be a directory \nnamed ```scripts```. Make sure the path ```C:\\your\\installation\\location\\Python\\Python3<version>\\scripts``` is a environment variable and you should be good to go.\n## Commands\n### <^> Main commands\ncreate: Creates a new process\n\nRequired arguments:\n- command: str (default: None)\n\nOptional arguments:\n- --name or -n : str (default: None)\n- --group or -g : str (default: process_id)\n- --relation or -r : \"parent\" | \"child\" (default: \"parent\")\n- --verbose or -v: (default: false)\n\nNote: A child process must have a group name and the group must have a parent process.\n\nExample:\n```\npm create \"<command>\"\nor\npm create \"<command>\" -n \"<process name>\" -g \"<group name>\" -r \"child\"\n```\nls: List all managed processes\n\nOptional arguments:\n- --json or -j: bool (default: false)\n- --group or -g: str (default: None)\n- --running or -r: bool (default: false)\nExample:\n```\npm ls\npm ls -j\npm ls -g <group_name>\npm ls -j -g <group_name>\npm ls -r \n```\nkill: Kill process, kills the process and also removes it from the json file.\n\nOptional arguments:\n- pid (no flag needed): int (default: 0) kills one process if it's a child process. Otherwise, kills the terminates \n- --group or -g: str (default: None) kills one group if exist\n- --child or -c: bool (default: False) kills all child process in a group\n- --all or -a : bool (default: false) kills all the process\n\nNote: Other than -c only one options can be used at a time. -c flag must be used with -g\n\nExample:\n```\npm kill <PID>\npm kill -g <group_name>\npm kill -g <group_name> -c\npm kill -a\n```\n### <^> Additional commands\nRecreate all process managed by the tool:\n```\npm recreate\n```\nPause a process\n```\npm pause <PID>\n```\nrespawn all paused process\n```\npm respawn\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Md. Mahmudul Hasan Riyad 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.",
"summary": "Manages processes",
"version": "1.2.15",
"project_urls": {
"Homepage": "https://github.com/mhriyad99/process_manager"
},
"split_keywords": [
"process manager",
" process",
" pm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8e6ec6f672c2dd47a5f8042fd47d5b6b90e6b619689c1225a01ad7a1c65c656a",
"md5": "7f5b94e7829ba83539410cc2e8680b18",
"sha256": "d8e0709bdb025e69d8fc0dce52d8cc5a5e4772ddd7a42cebd6085ab7f46735a8"
},
"downloads": -1,
"filename": "pmflow-1.2.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7f5b94e7829ba83539410cc2e8680b18",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 9305,
"upload_time": "2024-11-17T12:17:50",
"upload_time_iso_8601": "2024-11-17T12:17:50.279773Z",
"url": "https://files.pythonhosted.org/packages/8e/6e/c6f672c2dd47a5f8042fd47d5b6b90e6b619689c1225a01ad7a1c65c656a/pmflow-1.2.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9db99345a50447633493ebba799d15f14f173640a3aae1ffde16a2a7b35ee978",
"md5": "cb19e68ae30aab2e84ba4c0409ddcb26",
"sha256": "eceabebb349aa5192837d4a6c312b98b1f55d07eba95bc5edaab1a0d53cf87bf"
},
"downloads": -1,
"filename": "pmflow-1.2.15.tar.gz",
"has_sig": false,
"md5_digest": "cb19e68ae30aab2e84ba4c0409ddcb26",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 8776,
"upload_time": "2024-11-17T12:17:52",
"upload_time_iso_8601": "2024-11-17T12:17:52.426823Z",
"url": "https://files.pythonhosted.org/packages/9d/b9/9345a50447633493ebba799d15f14f173640a3aae1ffde16a2a7b35ee978/pmflow-1.2.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-17 12:17:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mhriyad99",
"github_project": "process_manager",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "pmflow"
}
