Metadata-Version: 2.1
Name: phi_masker_utils
Version: 0.1.1
Summary: Collection of Python modules for masking PHI in delimited files and Excel worksheets.
Home-page: https://github.com/jai-python3/phi-masker-utils
Author: Jaideep Sundaram
Author-email: jai.python3@gmail.com
Keywords: phi_masker_utils
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: Click>=7.0
Requires-Dist: faker
Requires-Dist: Rich
Requires-Dist: PyYAML

================
PHI Masker Utils
================


Collection of Python modules for masking PHI in delimited files and Excel worksheets.

Usage
-----

.. code-block:: python

    from phi_masker_utils import Masker

    config_file = "conf/config.yaml"
    config = yaml.safe_load(Path(config_file).read_text())

    # Tab-delimited file
    infile = "my.tsv"
    outfile = "my_masked.tsv"

    # Or comma-separated file
    infile = "my.csv"
    outfile = "my_masked.csv"

    masker = Masker(
        config=config,
        config_file=config_file,
        infile=infile,
        logfile=logfile,
        outdir=outdir,
        outfile=outfile,
        verbose=verbose,
    )

    masker.mask_phi_values()

Exported Script
---------------

.. code-block:: shell

    mask-file --infile ~/projects/phi-masker-utils/labguru_mockup.csv --outdir .
    --config_file was not specified and therefore was set to 
    '/tmp/phi-masker-utils/venv/lib/python3.10/site-packages/phi_masker_utils/conf/config.yaml'
    --logfile was not specified and therefore was set to './mask_file.log'
    --outfile was not specified and therefore was set to './labguru_mockup.csv'


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

0.1.0 (2024-09-15)
------------------

* First release on PyPI.
