Metadata-Version: 2.4
Name: LBW_Guard
Version: 1.1.0
Summary: Learn-By-Wire Guard packaged runtime
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: torch

# LBW_Guard

`lbw` is the packaged, production-oriented runtime for Learn-By-Wire Guard.

Copyright (c) Qluon Inc. All rights reserved.

## Identity

- Product: `LBW_Guard` / Learn-By-Wire Guard
- Product owner: `Qluon Inc.`
- Company domain: `qluon.ai`
- Product web domain: `www.learnbywire.ai`
- Support email: `support@qluon.ai`
- Licensing model: `lbw_guard_eval` is freemium; `lbw_guard_std` and `lbw_guard_pro` are licensed editions.

## Customer Path

For customer delivery and integration, the main expectation is:

- install the vendor-provided `lbw` package, wheel, or runtime artifacts
- use [`docs/customer/INDEX.md`](./docs/customer/INDEX.md) as the main customer-facing entrypoint

Customer-facing quick links:

- [`docs/customer/GETTING_STARTED.md`](./docs/customer/GETTING_STARTED.md)
- [`docs/customer/CUSTOMER_PACKAGE.md`](./docs/customer/CUSTOMER_PACKAGE.md)
- [`docs/customer/DEMO_SCRIPTS.md`](./docs/customer/DEMO_SCRIPTS.md)
- [`docs/customer/TERMS_OF_SERVICE.md`](./docs/customer/TERMS_OF_SERVICE.md)
- [`docs/customer/PRIVACY_POLICY.md`](./docs/customer/PRIVACY_POLICY.md)

## Runtime Layout

- `lbw/governor.py`: `LearnByWire` governor API + AdamW runtime loop
- `lbw/lic.py`: edition gate + signed license verification
- `lbw/pro.py` / `lbw/pro.pyx`: Guard Pro reflex engine
- `lbw/public_keys.py`: embedded public key registry (generated at build time)

## Public API

- `from lbw import Guard` for `lbw_guard_eval` / `lbw_guard_std` / `lbw_guard_pro`
- The underlying `LearnByWire` class remains available for compatibility, but `Guard` is the public API.

## Source Build Path

This path is for:

- internal development
- release engineering
- source-package evaluation when explicitly provided

Build helpers:

- `build_product.py`: builds `lbw.governor`, `lbw.lic`, `lbw.public_keys`
- `build_pro.py`: builds `lbw.pro`
- `keygen.py`: internal RSA keypair generation tool
- `issue_license.py`: internal signed license issuing tool

### Quick Build

Run from the `lbw` repo root:

```bash
python build_product.py build_ext --inplace
python build_pro.py build_ext --inplace
```

Production build with embedded key:

```bash
LBW_PRODUCT_PUBLIC_KEY_FILE=/secure/lbw_public.json python build_product.py build_ext --inplace
python build_pro.py build_ext --inplace
```

## Documentation

Start from:

- [`docs/customer/INDEX.md`](./docs/customer/INDEX.md) for customer-facing delivery and integration
- [`docs/INDEX.md`](./docs/INDEX.md) for the full technical documentation set
- [`docs/internal/INDEX.md`](./docs/internal/INDEX.md) for vendor/internal licensing, build, and release docs
