## Requirements

- Python 3.12+
- uv for package management and building
- Pydantic for the data parts.

## Installation
```
pip install uv
uv pip install pymultirole-plugins
```

## Development Setup
```
uv sync
```

## Running Tests
```
uv run pytest
```

## Linting and Formatting
```
uv run ruff check .
uv run ruff format --check .
```

## Generate Documentation
```
uv run --extra docs sphinx-build docs docs/_build
```

## SBOM & vulnerability check

Install the SBOM dependencies:

```
uv sync --extra sbom
```

Generate a CycloneDX SBOM from the current environment:

```
uv run cyclonedx-py environment -o sbom.cdx.json --output-format json
```

Audit dependencies for known vulnerabilities:

```
uv run pip-audit --format json --output audit-report.json
```

To fail on any known vulnerability (useful in CI):

```
uv run pip-audit --strict
```

## Publish the Python Package to PyPI
- Increment the version of your package in the `__init__.py` file:
```
"""Sherpa multirole plugins"""

__version__ = 'x.y.z'
```
- Build and publish
```
uv build
uv publish
```
