Skip to main content

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

runtime_reporting_utils-0.1.0.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

runtime_reporting_utils-0.1.0-py2.py3-none-any.whl (8.8 kB view details)

Uploaded Python 2Python 3

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

Hashes for runtime_reporting_utils-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c474e60b6837f59f9896f62ca0bdf652cf46fa00c827fa15032c0d6a1fc851ef
MD5 6b57fff2e5b8bde0fd07b7f561e5a169
BLAKE2b-256 8193fdf082f8e4a9fa874a6dab0a34364c823566e3f0bd5b0a2fedf67aa04005

See more details on using hashes here.

File details

Details for the file runtime_reporting_utils-0.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for runtime_reporting_utils-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6c15309cc59e859b90cdc19038b2077d6ca3ba09aaaccec9abde08d73d15bc4e
MD5 4d0a6cd828a9dfde08d87f8e857ba997
BLAKE2b-256 de0b46471e55823e66bac6da721845e513d3de110ad2c6d8650a8c0e205ec28f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page