Metadata-Version: 2.1
Name: shs-validate
Version: 1.7.1
Summary: utilities for parameter validation
Home-page: https://gitlab.dillinger.de/KI/DataScience/utils/shs-validate
Author: Boris Wiegand
Author-email: boris.wiegand@stahl-holding-saar.de
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Validation
Classifier: Topic :: Arguments
Classifier: Topic :: Parameters
Description-Content-Type: text/markdown

# SHS Validate

Implements validation routines in order to reduce boilerplate code for parameter
checking.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

Python 3.10+

### Installing

This package does not require to install any dependencies. Feel free to install
the development helpers in requirements-dev in case you want to develop and run
tests locally.

If you want to use this library in a project, just install

```
python -m pip install
       -i http://nexus.int.shsservices.de/repository/ki-python-releases/simple
       --trusted-host nexus.int.shsservices.de shs-validate
```

If pip is already configured to use the nexus repository:

```
pip install shs-validate
```

## Usage

```python
import shs_validate

def is_prime(n: int) -> bool:
    shs_validate.greater(n, 0)
    ...
```

## Running the tests

```
make test
```

## Deployment

When changes are pushed into the master branch, the project is bundled and
uploaded to our Nexus automatically.

## Versioning

We use [SemVer](http://semver.org/) for versioning.

## Authors

* **Boris Wiegand** - boris.wiegand@stahl-holding-saar.de

See also the list of [contributors](https://gitlab.dillinger.de/KI/DataScience/processmining/prolothar-constraint-acquisition/-/graphs/master) who participated in this project.



