Metadata-Version: 2.4
Name: gzcmd-record-linkage
Version: 0.1.0
Summary: Deterministic policy engine for clerical review linkage decision support
Project-URL: Homepage, https://github.com/marco-jardim/gzcmd-record-linkage
Project-URL: Source, https://github.com/marco-jardim/gzcmd-record-linkage
Author: Marco Jardim
License: MIT
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Requires-Dist: joblib>=1.3
Requires-Dist: numpy>=1.26
Requires-Dist: pandas>=2.1
Requires-Dist: pyyaml>=6.0
Requires-Dist: requests>=2.31
Requires-Dist: scikit-learn>=1.4
Requires-Dist: scipy>=1.11
Provides-Extra: dev
Requires-Dist: pyright>=1.1; extra == 'dev'
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.6; extra == 'dev'
Description-Content-Type: text/markdown

# GZ-CMD-Record-Linkage

Reference implementation of the GZ-CMD++ v3 policy engine, packaged as a reusable
Python package with `src` layout and CLI entry points.

## Package

- PyPI package name: `gzcmd-record-linkage`
- Import package: `gzcmd_record_linkage`

## Install

- Editable install for development:

```bash
python -m pip install -e .[dev]
```

- Runtime only:

```bash
python -m pip install -e .
```

The package version is derived from git tags using `hatch-vcs`.

## Development

- Lint:

```bash
ruff check src/gzcmd_record_linkage/cli.py tests
```

- Tests with coverage target:

```bash
pytest --cov=gzcmd_record_linkage.loader \
  --cov=gzcmd_record_linkage.classifier \
  --cov=gzcmd_record_linkage.bands \
  --cov=gzcmd_record_linkage.guardrails \
  --cov-fail-under=80
```

- Build:

```bash
python -m build
```

## CLI

The package exposes a `gzcmd` CLI entry point.

```bash
gzcmd --help
```

You can also invoke the module directly:

```bash
python -m gzcmd_record_linkage --help
```
