Metadata-Version: 2.4
Name: py-commons-ip
Version: 0.3.2
Summary: A wrapper library to use the commons-ip library in Python
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: pytest==8.4.1; extra == "dev"
Requires-Dist: ruff==0.12.7; extra == "dev"
Requires-Dist: build==1.3.0; extra == "dev"
Requires-Dist: twine==6.1.0; extra == "dev"
Dynamic: license-file

# Python Commons IP

## Introduction
This repository provides a Python interface to the Commons IP validator.

## Usage
```python
import py_commons_ip
succes, report = py_commons_ip.validate("/path/to/unzipped/zip")
```

## Building

Fetch the commons-ip submodule.

```sh
git submodule update --init --remote
```

Use the Makefile to build the JAR file. This requires a Java runtime and Maven.

```sh
make
```

The JAR file will be copied to `py_commons_ip/resources`.

## Release

Bump the version in `pyproject.toml` and add a matching tag `vX.Y.Z` to the commit to start the CI/CD.
