Metadata-Version: 2.1
Name: igs-toolbox
Version: 1.4.7
Summary: A toolbox to check whether files follow a predefined schema.
Author-email: IGS Developers <IGS-Developers@rki.de>
License: The MIT License (MIT)
        
        Copyright (c) 2022 NA
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://www.rki.de/DE/Content/Infekt/IGS/IGS_node.html
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: jsonschema >=4.16.0
Requires-Dist: pandas >=2.0.0
Requires-Dist: pdf2image >=1.16.3
Requires-Dist: opencv-python >=4.8.0.76
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: ruff ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'

# 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
```
