Skip to main content

pipen-runinfo

Generate running information for jobs in pipen pipelines.

Including session info (packages and versions), time, and device info.

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 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.

Metadata

Release files for pipen-runinfo 1.1.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pipen-runinfo 1.1.5
File Size Uploaded
pipen_runinfo-1.1.5.tar.gz 234.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pipen-runinfo 1.1.5
File Interpreter ABI Platform
pipen_runinfo-1.1.5-py3-none-any.whl Python 3 none any Details

Total release size: 241.9 kB

Release files / pipen_runinfo-1.1.5.tar.gz

Download URL pipen_runinfo-1.1.5.tar.gz
Size 234.9 kB
Tags Source
SHA-256 checksum
How to use checksums
2275d027cb4ced90055d23df7b0768efe9f1d43d90be0d09d2456c2bf25e9dd4
BLAKE2b-256 checksum
How to use checksums
c911fcdf09f71075dd100adaf060718e231f6825eff9f4a5e3842dbe79ddd635
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.2 {"installer":{"name":"uv","version":"0.12.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / pipen_runinfo-1.1.5-py3-none-any.whl

Download URL pipen_runinfo-1.1.5-py3-none-any.whl
Size 7.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fd86e09b5fa29958ca335e3d4219f6397f272a061a3a859c356c891138d41d06
BLAKE2b-256 checksum
How to use checksums
f73ece69e748965205ad03ff686aedb17afa6e41105077ce3680fbcaa9e42850
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.2 {"installer":{"name":"uv","version":"0.12.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

This release

1.1.5 This release

2 release files

1.1.4

2 release files

1.1.3

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.0

2 release files

0.9.3

2 release files

0.9.2

2 release files

0.9.1

2 release files

0.9.0

2 release files

0.8.3

2 release files

0.8.2

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page