Metadata-Version: 2.1
Name: previsedx_quantstudio_file_utils
Version: 0.1.2
Summary: Collection of modules for processing QuantStudio files.
Home-page: https://github.com/sundaram-previsedx/previsedx-quantstudio-file-utils
Author: Jaideep Sundaram
Author-email: sundaram.previse@gmail.com
License: UNKNOWN
Keywords: previsedx_quantstudio_file_utils
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.10
License-File: LICENSE
License-File: AUTHORS.rst

================================
PreviseDx QuantStudio File Utils
================================

Collection of Python modules for processing QuantStudio files

.. image:: use_cases.png
    :alt: Use Case Diagram
    :align: center


.. image:: class_diagrams.png
    :alt: Class Diagram
    :align: center


Usage
-----
.. code-block:: python

    import os
    from previsedx_quantstudio_file_utils import QuantStudioXlsxParser as Parser
    from previsedx_quantstudio_file_utils import constants
    import yaml
    from pathlib import Path

    config_file = "conf/config.yaml"
    if not os.path.exists(config_file):
        config_file = constants.DEFAULT_CONFIG_FILE
    config = yaml.safe_load(Path(config_file).read_text())

    parser = Parser(
        config=config,
        config_file=config_file,
        logfile=logfile,
        outdir=outdir,
        outfile=outfile,
        verbose=constants.verbose,
    )

    infile = "quantstudio.xls"
    records = parser.get_records(infile)
    for record in records:
        print(f"Quantity mean is '{record.quantitymean}' for sample '{record.samplename}'")


=======
History
=======

0.1.0 (2024-09-08)
------------------

* First release on PyPI.


