Metadata-Version: 2.1
Name: igs-toolbox
Version: 1.4.0
Summary: A toolbox to check whether files follow a predefined schema.
Home-page: https://www.rki.de/DE/Content/Infekt/IGS/IGS_node.html
Author: IGS Developers
Author-email: IGS-Developers@rki.de
License: MIT
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: jsonschema >=4.16.0
Requires-Dist: pandas >=2.1.1
Requires-Dist: pdf2image >=1.16.3
Requires-Dist: opencv-python >=4.8.0.76
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'

# igs-toolbox

## Description
This Python package contains tools to check whether files follow predefined schemas of the IGS project.
Currently, only a JSON validator is implemented, but the idea is that it will be extended to more applications related to the IGS project in the future.

## Installation 

igs-toolbox is installable using pip.

```bash
pip install igs-toolbox
```

## Usage
All tools can be used directly through the commandline.

### jsonChecker

```bash
usage: jsonChecker [-h] -i INPUT 

optional arguments:
  -h, --help            show this help message and exit
  -i INPUT, --input INPUT
                        Filepath to json file.
```

### readQR

The method readQR reads the Meldungsquittung and extracts the MeldungsID. 

Poppler is required to read the pdfs
```bash
conda install poppler
or
mamba install poppler
or
apt install poppler-utils
```


```bash
usage: readQR [-h] [--version] [file ...]

positional arguments:
  file

options:
  -h, --help  show this help message and exit
  --version   show program's version number and exit
```

Example:
```bash
readQR *.pdf
```
