Metadata-Version: 2.2
Name: runtime_reporting_utils
Version: 0.1.0
Summary: Python module for reporting runtime metadata.
Home-page: https://github.com/jai-python3/runtime-reporting-utils
Author: Jaideep Sundaram
Author-email: jai.python3@gmail.com
Keywords: runtime_reporting_utils
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.6
License-File: AUTHORS.rst
Requires-Dist: Click>=7.0
Requires-Dist: PyYAML
Requires-Dist: Rich
Requires-Dist: singleton-decorator
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

=======================
Runtime Reporting Utils
=======================


Python module for reporting runtime metadata.


.. code-block:: python

    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.
