Generate running information for jobs in pipen pipelines
Project description
pipen-runinfo
Generate running information for jobs in pipen pipelines.
Install
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. Default isNone
, which means it will be inferred from theproc.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 running information. Default isTrue
. This option could be either specified in the process-level or the pipeline-level. Only works forpython
.runinfo_submod
: Whether to include submodules in the running information. Default isFalse
. This option could be either specified in the process-level or the pipeline-level. Only works forpython
.
Supported languages
python
, R
, bash
, and fish
.
Usage
The plugin will generate a job.runinfo
file in the job directory of the pipeline, which contains the running information of the job.
Python
Generates a TSV file with the following columns:
Name
: The name of the module, or python itself__version__
: The version fetched bymodule.__version__
ormodule.version
importlib.metadata
: The version fetched byimportlib.metadata.version(package)
Path
: The path of the module (only ifruninfo_path
isTrue
)
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pipen_runinfo-0.0.0.tar.gz
(4.0 kB
view hashes)
Built Distribution
Close
Hashes for pipen_runinfo-0.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bfde01f1a6a03a24db84ae8f3022b73e3e624dcf146993497721315fbd06433f |
|
MD5 | b5227e637f6eea7f7ccedd00b7a58006 |
|
BLAKE2b-256 | 788d4887f8e2f9743704fa6b1ff66581b2fa4936777b450e61ace02f6ef5c682 |