Metadata-Version: 2.5
Name: stanzaapi-container-validator
Version: 1.0.0
Summary: Official zero-dependency, high-speed Python client for ISO 6346 Container & Chassis Check-Digit Validator
Project-URL: Homepage, https://stanzaapi.com/tools/container-validator
Project-URL: Repository, https://github.com/StanzaAPI/container-validator-python
Author: Stanza
License-Expression: MIT
Keywords: bic-code,chassis,check-digit,container,freight,intermodal,iso-6346,logistics,shipping
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# ISO 6346 Container & Chassis Check-Digit Validator — Python SDK

[![PyPI version](https://img.shields.io/pypi/v/stanzaapi-container-validator.svg)](https://pypi.org/project/stanzaapi-container-validator/)
[![Python Versions](https://img.shields.io/pypi/pyversions/stanzaapi-container-validator.svg)](https://pypi.org/project/stanzaapi-container-validator/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Stanza API](https://img.shields.io/badge/Powered%20by-Stanza-blue)](https://stanzaapi.com)

> MOD-11 check digit validator and ISO 6346 size/type decoder for intermodal shipping containers, chassis, and trailers.

Official, zero-dependency Python 3.8+ client library for **ISO 6346 Container & Chassis Check-Digit Validator**, built on the [Stanza Micro-API Network](https://stanzaapi.com). Intended for enterprise data pipelines, backend verification, and sub-5ms edge compute.

* 🌐 **Live Web Playground:** [Test your inputs online](https://stanzaapi.com/tools/container-validator)
* 📚 **API Documentation:** [View full schema on Stanza](https://stanzaapi.com/tools/container-validator)
* ⚡ **Platform Overview:** [Explore the Stanza Developer Network](https://stanzaapi.com)

---

## 📦 Installation

```bash
pip install stanzaapi-container-validator
```

---

## 🚀 Quickstart

```python
import os
from stanzaapi_container_validator import ContainerValidatorClient

# Initialize client (api_key optional for local evaluation)
client = ContainerValidatorClient(
    api_key=os.getenv("STANZA_API_KEY")
)

# Execute deterministic validation
response = client.validate("MSKU0123456")

if response.get("success"):
    print("Verification Success:", response["data"])
else:
    print("Validation Error:", response.get("error"), response.get("code"))
```

---

## 📄 Example Response

```json
{
  "success": true,
  "data": {
    "valid": true,
    "owner_code": "MSK",
    "category": "U",
    "serial_number": "012345",
    "check_digit": 6
  }
}
```

---

## ⚙️ Client Options

| Parameter | Type | Default | Description |
| :--- | :--- | :--- | :--- |
| `api_key` | `Optional[str]` | `os.getenv("STANZA_API_KEY")` | Your [Stanza API Key](https://stanzaapi.com). Required for production quotas. |
| `base_url` | `Optional[str]` | `"https://api.stanzaapi.com/container-validator"` | Public edge API base URL. |
| `timeout` | `int` | `15` | Request timeout in seconds. |


---

## 🔗 Useful Links

* [ISO 6346 Container & Chassis Check-Digit Validator Interactive Sandbox](https://stanzaapi.com/tools/container-validator)
* [Stanza Developer Directory](https://stanzaapi.com)
* [Source Code & Issue Tracker](https://github.com/StanzaAPI/container-validator-python)

## 📄 License

MIT © Stanza — Powered by [Stanza](https://stanzaapi.com).
