Metadata-Version: 2.1
Name: nmicheck
Version: 0.1.0
Summary: Functions to validate National Metering Identifiers (NMIs)
Author-email: Alex Guinman <alex@guinman.id.au>
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Requires-Dist: ruff ; extra == "test"
Requires-Dist: pytest >=2.7.3 ; extra == "test"
Requires-Dist: pytest-cov ; extra == "test"
Requires-Dist: mypy ; extra == "test"
Project-URL: Source, https://github.com/aguinane/NMI-Checksum/
Provides-Extra: test

# NMI-Checksum

A library to validate National Metering Identifiers (NMIs)

The validation rules are as per the [National Metering Identifier Procedure](https://aemo.com.au/Electricity/National-Electricity-Market-NEM/Retail-and-metering/-/media/EBA9363B984841079712B3AAD374A859.ashx).

## Usage

```python
from nmicheck import nmi_checksum
checksum = nmi_checksum("QAAAVZZZZZ")
print(checksum)  # 3
```

```python
from nmicheck import checksum_valid
print(checksum_valid("QAAAVZZZZZ3"))  # True
print(checksum_valid("QAAAVZZZZZ0"))  # False
```

