Python module for reporting runtime metadata.
Project description
Runtime Reporting Utils
Python module for reporting runtime metadata.
from runtime_reporting_utils import RuntimeReporter
rr = RuntimeReporter()
rr.add_file(file=logfile, name="log file")
rr.add_file(file=config_file, name="configuration file")
rr.add_file(file=outfile, name="main output file")
rr.count(name="gene", desc="Number of genes processed")
rr.count(name="missing-annotation", desc="Number of genes that do not have annotation")
# Set the output directory.
# Default will be /tmp/[USER]/runtime-reporting-utils/[basename of executable]/YYYY-MM-DD-HHMMSS/
rr.outdir(outdir)
# When the primary Python executable completes, the RuntimeReporter's destructor will be invoked.
# At that time, the RuntimeReport will write the runtime report to the output directory.
# The file will be named runtime_report.json.
History
0.1.0 (2025-02-08)
First release on PyPI.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file runtime_reporting_utils-0.1.0.tar.gz.
File metadata
- Download URL: runtime_reporting_utils-0.1.0.tar.gz
- Upload date:
- Size: 13.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c474e60b6837f59f9896f62ca0bdf652cf46fa00c827fa15032c0d6a1fc851ef
|
|
| MD5 |
6b57fff2e5b8bde0fd07b7f561e5a169
|
|
| BLAKE2b-256 |
8193fdf082f8e4a9fa874a6dab0a34364c823566e3f0bd5b0a2fedf67aa04005
|
File details
Details for the file runtime_reporting_utils-0.1.0-py2.py3-none-any.whl.
File metadata
- Download URL: runtime_reporting_utils-0.1.0-py2.py3-none-any.whl
- Upload date:
- Size: 8.8 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6c15309cc59e859b90cdc19038b2077d6ca3ba09aaaccec9abde08d73d15bc4e
|
|
| MD5 |
4d0a6cd828a9dfde08d87f8e857ba997
|
|
| BLAKE2b-256 |
de0b46471e55823e66bac6da721845e513d3de110ad2c6d8650a8c0e205ec28f
|