| Name | pipen-runinfo JSON |
| Version |
0.6.0
JSON |
| download |
| home_page | |
| Summary | Generate running information for jobs in pipen pipelines |
| upload_time | 2024-02-05 19:15:50 |
| maintainer | |
| docs_url | None |
| author | pwwang |
| requires_python | >=3.9,<4.0 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pipen-runinfo
Generate running information for jobs in [pipen][1] pipelines.
Including session info (packages and versions), time, and device info.
## Install
```bash
pip install -U pipen-runinfo
```
## Enable/Disable the plugin
The plugin is registered via entrypoints. It's by default enabled. To disable it: plugins=[..., "no:runinfo"], or uninstall this plugin.
## Plugin options
- `runinfo_lang`: The name of the language to run the job script for session info.
Default is `None`, which means it will be inferred from the `proc.lang`
This should be a process-level option, unless you only have one single
process in your pipeline.
- `runinfo_path`: Whether to include paths for the modules in the session information.
Default is `True`.
This option could be either specified in the process-level or the pipeline-level.
Only works for `python`.
- `runinfo_submod`: Whether to include submodules in the session information.
Default is `False`.
This option could be either specified in the process-level or the pipeline-level.
Only works for `python`.
## Supported languages for session info
`python`, `R`, `bash`, and `fish`.
## Usage
The plugin will generate 3 files in the job directory of the pipeline.
### `job.runinfo.session`
The session information of the job, including the interpreter, packages and their versions.
#### Python
Generates a TSV file with the following columns:
- `Name`: The name of the module, or python itself
- `__version__`: The version fetched by `module.__version__` or `module.version`
- `importlib.metadata`: The version fetched by `importlib.metadata.version(package)`
- `Path`: The path of the module (only if `runinfo_path` is `True`)
#### R
Generates a text file `sessionInfo()` output.
#### Bash
Generates a TSV file with the following columns:
- `SHELL`: The value of `$SHELL`
- `BASH_VERSION`: The value of `$BASH_VERSION`
- `BASH_ARGV0`: The value of `$BASH_ARGV0`
- `BASH_SOURCE`: The value of `$BASH_SOURCE`
- `proc-exe`: The real path of the executable from `/proc/<pid>/exe`
- `proc-exe-version`: The version of the executable from `/proc/<pid>/exe --version`
#### Fish
Generates a TSV file with the following columns:
- `SHELL`: The value of `$SHELL`
- `FISH_VERSION`: The value of `$FISH_VERSION`
- `proc-exe`: The real path of the executable from `/proc/<pid>/exe`
- `proc-exe-version`: The version of the executable from `/proc/<pid>/exe --version`
### `job.runinfo.time`
The time spent on the job, and more, generated by `time -v` command.
### `job.runinfo.device`
The device (cpu and memory) information of the job, generated by `lscpu`/`lsmem` command.
[1]: https://github.com/pwwang/pipen
Raw data
{
"_id": null,
"home_page": "",
"name": "pipen-runinfo",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "pwwang",
"author_email": "pwwang@pwwang.com",
"download_url": "https://files.pythonhosted.org/packages/14/1b/b77b30b0a63516de3aa81169d6c37f37c6a95df0188ad13c12cbed4978bd/pipen_runinfo-0.6.0.tar.gz",
"platform": null,
"description": "# pipen-runinfo\n\nGenerate running information for jobs in [pipen][1] pipelines.\n\nIncluding session info (packages and versions), time, and device info.\n\n## Install\n\n```bash\npip install -U pipen-runinfo\n```\n\n## Enable/Disable the plugin\n\nThe plugin is registered via entrypoints. It's by default enabled. To disable it: plugins=[..., \"no:runinfo\"], or uninstall this plugin.\n\n## Plugin options\n\n- `runinfo_lang`: The name of the language to run the job script for session info.\n Default is `None`, which means it will be inferred from the `proc.lang`\n This should be a process-level option, unless you only have one single\n process in your pipeline.\n- `runinfo_path`: Whether to include paths for the modules in the session information.\n Default is `True`.\n This option could be either specified in the process-level or the pipeline-level.\n Only works for `python`.\n- `runinfo_submod`: Whether to include submodules in the session information.\n Default is `False`.\n This option could be either specified in the process-level or the pipeline-level.\n Only works for `python`.\n\n## Supported languages for session info\n\n`python`, `R`, `bash`, and `fish`.\n\n## Usage\n\nThe plugin will generate 3 files in the job directory of the pipeline.\n\n### `job.runinfo.session`\n\nThe session information of the job, including the interpreter, packages and their versions.\n\n#### Python\n\nGenerates a TSV file with the following columns:\n\n- `Name`: The name of the module, or python itself\n- `__version__`: The version fetched by `module.__version__` or `module.version`\n- `importlib.metadata`: The version fetched by `importlib.metadata.version(package)`\n- `Path`: The path of the module (only if `runinfo_path` is `True`)\n\n#### R\n\nGenerates a text file `sessionInfo()` output.\n\n#### Bash\n\nGenerates a TSV file with the following columns:\n\n- `SHELL`: The value of `$SHELL`\n- `BASH_VERSION`: The value of `$BASH_VERSION`\n- `BASH_ARGV0`: The value of `$BASH_ARGV0`\n- `BASH_SOURCE`: The value of `$BASH_SOURCE`\n- `proc-exe`: The real path of the executable from `/proc/<pid>/exe`\n- `proc-exe-version`: The version of the executable from `/proc/<pid>/exe --version`\n\n#### Fish\n\nGenerates a TSV file with the following columns:\n\n- `SHELL`: The value of `$SHELL`\n- `FISH_VERSION`: The value of `$FISH_VERSION`\n- `proc-exe`: The real path of the executable from `/proc/<pid>/exe`\n- `proc-exe-version`: The version of the executable from `/proc/<pid>/exe --version`\n\n### `job.runinfo.time`\n\nThe time spent on the job, and more, generated by `time -v` command.\n\n### `job.runinfo.device`\n\nThe device (cpu and memory) information of the job, generated by `lscpu`/`lsmem` command.\n\n\n[1]: https://github.com/pwwang/pipen\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Generate running information for jobs in pipen pipelines",
"version": "0.6.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "56acfa3b8d954fd0bb81bccf57e0fe06508bdcc2906deb5f46bf305aac538395",
"md5": "8a5c7c3b91aa8720e46b803b5c20dbc2",
"sha256": "0290e631e9965724a40e4da9498e20926795f0e178f190f4a0f5f7770a04e288"
},
"downloads": -1,
"filename": "pipen_runinfo-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8a5c7c3b91aa8720e46b803b5c20dbc2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 4492,
"upload_time": "2024-02-05T19:15:48",
"upload_time_iso_8601": "2024-02-05T19:15:48.942452Z",
"url": "https://files.pythonhosted.org/packages/56/ac/fa3b8d954fd0bb81bccf57e0fe06508bdcc2906deb5f46bf305aac538395/pipen_runinfo-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "141bb77b30b0a63516de3aa81169d6c37f37c6a95df0188ad13c12cbed4978bd",
"md5": "8eaa9b9d783446e75c57a01664eaec69",
"sha256": "47cbb3df58be42280c6e975838dc17316eed0b8a5baf2763b2d9803f66cf748c"
},
"downloads": -1,
"filename": "pipen_runinfo-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "8eaa9b9d783446e75c57a01664eaec69",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 4552,
"upload_time": "2024-02-05T19:15:50",
"upload_time_iso_8601": "2024-02-05T19:15:50.373377Z",
"url": "https://files.pythonhosted.org/packages/14/1b/b77b30b0a63516de3aa81169d6c37f37c6a95df0188ad13c12cbed4978bd/pipen_runinfo-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-05 19:15:50",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pipen-runinfo"
}
