Metadata-Version: 2.4
Name: phi-finder
Version: 0.1.1
Summary: Collection of tools to check uploaded scans and records for identifiable data.
Project-URL: repository, https://github.com/Australian-Imaging-Service/phi-finder
Author-email: Pedro Faustini <pedro.faustini@mq.edu.au>
Maintainer-email: Pedro Faustini <pedro.faustini@mq.edu.au>
Keywords: anonymisation,clinical data,dicom
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering
Requires-Python: <3.13,>=3.11
Requires-Dist: faker>=36.1.1
Requires-Dist: fileformats-medimage-extras
Requires-Dist: numpy==1.26.4
Requires-Dist: opencv-python>=4.10.0.84
Requires-Dist: pandas>=2.2.3
Requires-Dist: pdfminer-six>=20240706
Requires-Dist: pikepdf>=9.4.0
Requires-Dist: presidio-analyzer>=2.2.355
Requires-Dist: presidio-anonymizer>=2.2.355
Requires-Dist: presidio-image-redactor>=0.0.53
Requires-Dist: presidio-structured>=0.0.4a0
Requires-Dist: pymupdf>=1.24.13
Requires-Dist: spacy
Requires-Dist: torch==2.6.0
Requires-Dist: transformers>=4.48.2
Requires-Dist: typing-extensions>=4.6.3; python_version < '4.0'
Provides-Extra: dev
Requires-Dist: black; extra == 'dev'
Requires-Dist: codespell; extra == 'dev'
Requires-Dist: fileformats[test]; extra == 'dev'
Requires-Dist: flake8; extra == 'dev'
Requires-Dist: flake8-pyproject; extra == 'dev'
Requires-Dist: mypy>=1.5.1; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pydata-sphinx-theme>=0.13; extra == 'dev'
Requires-Dist: pydicom; extra == 'dev'
Provides-Extra: docs
Requires-Dist: docutils>=0.10; extra == 'docs'
Requires-Dist: furo>=2022.2.14.1; extra == 'docs'
Requires-Dist: mock>1.0; extra == 'docs'
Requires-Dist: numpydoc>=0.6.0; extra == 'docs'
Requires-Dist: packaging; extra == 'docs'
Requires-Dist: sphinx-argparse>=0.2.0; extra == 'docs'
Requires-Dist: sphinx-click>=3.1; extra == 'docs'
Requires-Dist: sphinx>=2.1.2; extra == 'docs'
Provides-Extra: test
Requires-Dist: fileformats-extras; extra == 'test'
Requires-Dist: fileformats-medimage-extras; extra == 'test'
Requires-Dist: frametree-xnat>=0.6.4; extra == 'test'
Requires-Dist: frametree>=0.14.5; extra == 'test'
Requires-Dist: medimages4tests; extra == 'test'
Requires-Dist: mypy>=1.5.1; extra == 'test'
Requires-Dist: openpyxl; extra == 'test'
Requires-Dist: pydra2app-xnat>=0.8.0; extra == 'test'
Requires-Dist: pydra2app>=0.18.8; extra == 'test'
Requires-Dist: pydra==1.0a1; extra == 'test'
Requires-Dist: pytest-cov>=2.12.1; extra == 'test'
Requires-Dist: pytest-env>=0.6.2; extra == 'test'
Requires-Dist: pytest>=6.2.5; extra == 'test'
Requires-Dist: thinc>=8.3.4; extra == 'test'
Requires-Dist: xnat4tests; extra == 'test'
Requires-Dist: xnat>=0.7.0; extra == 'test'
Description-Content-Type: text/markdown

# PHI-finder

[![CI/CD](https://github.com/australian-imaging-service/phi-finder/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/australian-imaging-service/phi-finder/actions/workflows/ci-cd.yml)
[![Codecov](https://codecov.io/gh/australian-imaging-service/phi-finder/branch/main/graph/badge.svg?token=UIS0OGPST7)](https://codecov.io/gh/australian-imaging-service/phi-finder)

## Building

```bash
python -m pip install --upgrade build

python -m build

pip install dist/phi_finder-0.1.1-py3-none-any.whl
```

## (Very) Basic usage

```python
import pydicom as dicom
from phi_finder.dicom_tools import anonymise_dicom

dcm = dicom.dcmread("/path/to/some/dicom.dcm")
anonymised_dcm = anonymise_dicom.anonymise_image(dcm)

```
