=======================
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)
rr.generate_report()
# The RuntimeReport will write the runtime report to the output directory.
# The file will be named report.json.
=======
History
=======
0.1.0 (2025-02-08)
------------------
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/jai-python3/runtime-reporting-utils",
"name": "runtime-reporting-utils",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "runtime_reporting_utils",
"author": "Jaideep Sundaram",
"author_email": "jai.python3@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/42/98/4c7ca1b2fc47f5e32949320015d0603298d828ce005dfd6cb16f09579c21/runtime_reporting_utils-0.1.1.tar.gz",
"platform": null,
"description": "=======================\nRuntime Reporting Utils\n=======================\n\n\nPython module for reporting runtime metadata.\n\n\n.. code-block:: python\n\n from runtime_reporting_utils import RuntimeReporter\n\n rr = RuntimeReporter()\n\n rr.add_file(file=logfile, name=\"log file\")\n rr.add_file(file=config_file, name=\"configuration file\")\n rr.add_file(file=outfile, name=\"main output file\")\n\n rr.count(name=\"gene\", desc=\"Number of genes processed\")\n rr.count(name=\"missing-annotation\", desc=\"Number of genes that do not have annotation\")\n\n # Set the output directory.\n # Default will be /tmp/[USER]/runtime-reporting-utils/[basename of executable]/YYYY-MM-DD-HHMMSS/\n rr.outdir(outdir)\n\n rr.generate_report()\n # The RuntimeReport will write the runtime report to the output directory.\n # The file will be named report.json.\n\n\n=======\nHistory\n=======\n\n0.1.0 (2025-02-08)\n------------------\n\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": null,
"summary": "Python module for reporting runtime metadata.",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/jai-python3/runtime-reporting-utils"
},
"split_keywords": [
"runtime_reporting_utils"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "902f6582fe27c8548a8bf1701d067ff991243046ef9f5d825c0a397976ae4b29",
"md5": "6cf345cc20e9c3eeb41a0b2a7f34bb85",
"sha256": "7940bcdcabc4aefdbb56651c71d4eb205c78f9ade0601ea9e113fa4827c721e9"
},
"downloads": -1,
"filename": "runtime_reporting_utils-0.1.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "6cf345cc20e9c3eeb41a0b2a7f34bb85",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 8782,
"upload_time": "2025-02-09T20:02:40",
"upload_time_iso_8601": "2025-02-09T20:02:40.049413Z",
"url": "https://files.pythonhosted.org/packages/90/2f/6582fe27c8548a8bf1701d067ff991243046ef9f5d825c0a397976ae4b29/runtime_reporting_utils-0.1.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "42984c7ca1b2fc47f5e32949320015d0603298d828ce005dfd6cb16f09579c21",
"md5": "6f29f183e5136887be690b6a0e75b6ba",
"sha256": "1a84cd229800929f2def805cf819ba4eb9c28b568392276580291b8094014dd4"
},
"downloads": -1,
"filename": "runtime_reporting_utils-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "6f29f183e5136887be690b6a0e75b6ba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 13494,
"upload_time": "2025-02-09T20:02:42",
"upload_time_iso_8601": "2025-02-09T20:02:42.939980Z",
"url": "https://files.pythonhosted.org/packages/42/98/4c7ca1b2fc47f5e32949320015d0603298d828ce005dfd6cb16f09579c21/runtime_reporting_utils-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-09 20:02:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jai-python3",
"github_project": "runtime-reporting-utils",
"github_not_found": true,
"lcname": "runtime-reporting-utils"
}
JSON
