apii 0.1.0__tar.gz

apii-0.1.0/.gitignore

@@ -0,0 +1,25 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+
+# Local secrets / config — never commit
+.local/
+*.env
+.env
+*.vault
+
+# NER models (210 MB int8 ONNX; hosted externally, not in git)
+models/
+*.onnx
+
+# OS
+.DS_Store

apii-0.1.0/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

apii-0.1.0/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Aajil Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

apii-0.1.0/PKG-INFO

@@ -0,0 +1,305 @@
+Metadata-Version: 2.4
+Name: apii
+Version: 0.1.0
+Summary: Arabic/GCC PII detection, tokenization, and streaming-interception gateway.
+Project-URL: Homepage, https://github.com/Aajil-Labs/arabic-pii-py
+Project-URL: Repository, https://github.com/Aajil-Labs/arabic-pii-py
+Project-URL: NER models, https://huggingface.co/aajil-labs-sa/arabic-pii-ner
+Author-email: Aajil Labs <omar@aajil.sa>
+License: MIT OR Apache-2.0
+License-File: LICENSE-APACHE
+License-File: LICENSE-MIT
+Keywords: anonymization,arabic,gcc,llm,ner,pii,privacy,redaction,tokenization
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: Arabic
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security
+Classifier: Topic :: Text Processing :: Linguistic
+Requires-Python: >=3.10
+Requires-Dist: msgspec>=0.18
+Requires-Dist: regex>=2024.0
+Provides-Extra: cli
+Requires-Dist: cryptography>=42.0; extra == 'cli'
+Requires-Dist: typer>=0.12; extra == 'cli'
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Provides-Extra: documents
+Requires-Dist: pypdf>=4.0; extra == 'documents'
+Provides-Extra: ner
+Requires-Dist: huggingface-hub>=0.20; extra == 'ner'
+Requires-Dist: numpy>=1.24; extra == 'ner'
+Requires-Dist: onnxruntime>=1.17; extra == 'ner'
+Requires-Dist: tokenizers>=0.15; extra == 'ner'
+Provides-Extra: perf
+Requires-Dist: onnxruntime>=1.17; extra == 'perf'
+Requires-Dist: pyahocorasick>=2.0; extra == 'perf'
+Provides-Extra: proxy
+Requires-Dist: fastapi>=0.110; extra == 'proxy'
+Requires-Dist: httpx>=0.27; extra == 'proxy'
+Requires-Dist: uvicorn[standard]>=0.29; extra == 'proxy'
+Description-Content-Type: text/markdown
+
+# arabic-pii-py · `apii`
+
+> **Keep Arabic & GCC personal data off the LLM — without changing how you work.**
+> Names, IBANs, national IDs, phones, emails, addresses get swapped for
+> reversible tokens **on your machine**, before anything reaches Claude / GPT.
+> You keep seeing the real values. The model never does.
+
+Everything runs **locally**. No cloud, no account, no data leaves your laptop
+(the only network call is a one-time, optional model download you can replace).
+
+---
+
+## Why this exists
+
+If you work with GCC customer data — banks, telcos, government, clinics — you
+often legally **cannot** send that PII to a US-hosted LLM. `apii` lets you use
+Claude / GPT on that data anyway: the personal data stays on your machine, the
+model only ever sees placeholders like `EMAIL_C7E2…`, and the real values are
+restored locally for *you*.
+
+- 🇸🇦 **Built for Arabic & the GCC** — Saudi / Emirati / Qatari / Kuwaiti /
+  Bahraini / Omani shapes, IBAN ISO-7064 (MOD-97), national-ID checksums, and
+  on-device Arabic + English NER for names & organizations.
+- 💻 **100% local** — no service to run, no API key required, nothing uploaded.
+- 🪶 **Lightweight** — pure Python, **no PyTorch**; NER runs as int8 ONNX.
+- 🔁 **Reversible & stable** — the same value always maps to the same token, and
+  only *your* secret can turn it back.
+
+---
+
+## ⭐ The headline: transparent PII protection inside Claude Code
+
+This is the part most tools can't do. With one command, `apii` wires two hooks
+into Claude Code:
+
+| | what happens | result |
+|---|---|---|
+| **redact-on-read** | when Claude reads a file, PII in it is tokenized *before the model sees it* | Claude only ever sees `EMAIL_…`, `IBAN_…`, `PERSON_…` |
+| **restore-on-write** | when Claude writes/edits a file, the tokens are turned back into real values *before the bytes hit disk* | your **files come out correct**, the chat stays tokens |
+| **`apii watch`** | a side pane restores Claude's tokenized replies locally | **you** read the real values; Anthropic still only got tokens |
+
+It's **non-blocking** — you work normally; Claude just never receives the PII.
+
+```bash
+# in the project where you keep customer data:
+apii install-claude-hook          # one time — wires both hooks
+
+# open a fresh Claude Code session there (it loads the hook at startup)
+claude
+
+# and, in another terminal pane IN THE SAME PROJECT FOLDER, watch real values:
+apii watch          # follows this folder's session; --once dumps it so far
+```
+
+Now ask Claude to work on a file with PII. In the chat you'll see tokens; in the
+`apii watch` pane you'll see the real data; and your customer's information never
+left your machine.
+
+---
+
+## Install (from source — it's yours, no PyPI needed)
+
+Requires **Python 3.10+**.
+
+```bash
+git clone https://github.com/Aajil-Labs/arabic-pii-py.git
+cd arabic-pii-py
+
+python3 -m venv .venv && source .venv/bin/activate     # a 3.10+ interpreter
+pip install -e ".[ner,cli,proxy,documents]"            # editable, all features
+```
+
+That gives you the `apii` command. To use it outside the venv, either keep the
+venv active, or symlink it onto your `PATH`:
+
+```bash
+ln -sf "$PWD/.venv/bin/apii" ~/.local/bin/apii         # if ~/.local/bin is on PATH
+```
+
+**NER models** (names & organizations) auto-download once (~210 MB, int8 ONNX)
+from Hugging Face and cache under `~/.cache/huggingface`. Without them, every
+*structured* kind (email, phone, IBAN, ID, CR, VAT, address) still works — only
+`PERSON` / `ORGANIZATION` need the models. Point at your own copy any time with
+`APII_NER_MODEL` / `APII_NER_EN_MODEL`, or change the source repo with
+`APII_NER_HF_REPO`.
+
+Extras you can pick: `ner`, `cli`, `proxy` (streaming gateway), `documents`
+(pdf/docx/xlsx). Core (`pip install -e .`) is just regex + checksums.
+
+---
+
+## Ways to use it — pick what fits
+
+### 1. Claude Code (above) — the transparent, zero-friction path.
+
+### 2. CLI — text, files, and folders
+```bash
+# free text or a .txt file → tokens (mapping saved to a vault), then restore:
+echo "call 0501234567, email omar@aajil.sa" | apii redact --vault demo.vault
+apii restore answer.txt --vault demo.vault   # the model's tokens → real values
+
+apii detect notes.txt                        # audit only: detections as JSON
+
+# whole folders, format-aware (csv / json / docx / xlsx / pdf→txt):
+apii scan-dir ./statements --ext csv --out audit.jsonl
+apii redact-dir ./statements --out-dir ./masked --ext csv --vault s.vault
+```
+> `apii redact <file>` reads the file as text. For **documents**
+> (pdf/docx/xlsx/json) use `redact-dir` or the UI — they preserve layout.
+
+### 3. Local UI — paste-in / paste-out (+ file upload)
+```bash
+apii ui    # opens http://127.0.0.1:8765 — paste text or drop a CSV/Excel,
+           # take the tokens to any LLM, paste the reply back to restore.
+```
+
+### 4. As a library — embed it in your own app
+```python
+from apii.anonymizer import Anonymizer
+
+a = Anonymizer(secret="your-secret", tenant="acme")
+r = a.anonymize("Email omar@aajil.sa, IBAN SA0380000000608010167519")
+send_to_llm(r.text)                      # the model sees only tokens
+show_user(a.deanonymize(model_reply))    # real values restored locally
+```
+
+### 5. Drop-in proxy — protect an app you can't modify
+```bash
+pip install "apii[proxy]"
+apii serve    # local OpenAI-/Anthropic-compatible gateway on 127.0.0.1:8720
+# point your client's base URL at it (e.g. ANTHROPIC_BASE_URL=http://127.0.0.1:8720);
+# it anonymizes the request and de-anonymizes the streamed response, transparently.
+```
+
+---
+
+## What it detects
+
+| kind | how |
+|---|---|
+| `EMAIL` | format |
+| `PHONE` | GCC country codes, Saudi 05X, intl shapes |
+| `IBAN` | ISO-7064 **MOD-97** checksum (all 6 GCC countries) |
+| `TAX_NUMBER` | 15-digit Saudi / GCC VAT |
+| `COMMERCIAL_REGISTRATION` | 10-digit CR, label-cued |
+| `NATIONAL_ID` | UAE-784 / Saudi-Iqama / GCC |
+| `PERSON` | **on-device NER** (no name lists, no regex) |
+| `ORGANIZATION` | **on-device NER** |
+| `ADDRESS` | PO-box / street regex + NER locations |
+
+Quality is measured against a **1,340-span corpus of real, publicly-sourced
+values** (`tests/eval/`) — `pytest tests/python -q` runs it.
+
+---
+
+## Command reference
+
+| command | what it does |
+|---|---|
+| `apii redact [file]` | Anonymize text (stdin or a text file) → stdout; save the token↔value map to `--vault`. |
+| `apii restore [file] --vault V` | Reverse it: tokens → real values, using the vault. |
+| `apii detect [file]` | Audit mode — list detections as JSON, redact nothing. |
+| `apii scan-dir DIR --out F` | Detect across a folder; write per-file JSONL summaries + totals. |
+| `apii redact-dir DIR --out-dir D` | Redact every matching file (format-aware) into `--out-dir`, merging records into one `--vault`. |
+| `apii ui` | Local paste-in / paste-out web UI + file upload (`127.0.0.1:8765`). |
+| `apii serve` | Local anonymizing LLM proxy — `/v1/messages`, `/v1/chat/completions`, `/v1/responses` (needs `[proxy]`). |
+| `apii watch` | Side-viewer: tail the **current folder's** Claude session, restoring tokens for *your* screen. `--once` dumps the session so far. |
+| `apii install-claude-hook` | Wire redact-on-read + restore-on-write into Claude Code in one command (`--global` for all projects). |
+| `apii hook` | The per-event hook itself (stdin event JSON → response JSON); used by the installed hooks. |
+| `apii daemon` | Long-lived local hook daemon (`POST /hook`) — avoids a process spawn per event. |
+| `apii hook-client` | Thin bridge that relays a hook event to a running `daemon`. |
+
+Common flags: `--secret` (or `$APII_SECRET`), `--tenant`, `--vault`,
+`--policy strict|balanced|audit`, `--no-ner`. Run `apii <cmd> --help` for the rest.
+
+---
+
+## Environment variables
+
+| var | purpose |
+|---|---|
+| `APII_SECRET` | Vault HMAC / encryption key. Falls back to the managed `~/.apii/secret` (auto-created, `chmod 600`). |
+| `APII_HOME` | Config + vault directory (default `~/.apii`). |
+| `APII_POLICY` | Default policy: `strict` (default) / `balanced` / `audit`. |
+| `APII_NER_CASE_AUG` | Lowercase-name recovery: `auto` (default — fires on fully-lowercase input) / `always` (mixed-case too) / `off`. |
+| `APII_NER_THRESHOLD` | NER minimum confidence (default `0.85`). |
+| `APII_NER_MODEL` / `APII_NER_EN_MODEL` | Use your own local Arabic / English ONNX model dirs (override the auto-download). |
+| `APII_NER_HF_REPO` | Hugging Face repo to fetch models from (default `aajil-labs-sa/arabic-pii-ner`). |
+| `APII_NER_NO_DOWNLOAD` | Set to disable the model auto-download (fully offline). |
+| `APII_ANTHROPIC_BASE` / `APII_OPENAI_BASE` | Upstream targets for `apii serve`. |
+| `APII_SUPPRESS_PHRASES` | Path to a phrase file of structural vocabulary to never tokenize. |
+| `APII_GEO_GAZETTEER` | Path to an optional geo gazetteer for address detection. |
+
+---
+
+## How it stays private (the model)
+
+Two separate boundaries — that's the whole trick:
+
+- **Privacy boundary** = what the LLM receives → **only tokens**, always.
+- **Display boundary** = what *you* see → real values, because it's your data on
+  your machine.
+
+The bridge is a local, encrypted **vault** (`~/.apii/default.vault`, ChaCha20)
+plus a secret (`~/.apii/secret`, `chmod 600`). Tokens are
+`HMAC-SHA256(secret, value)` — deterministic, and irreversible without your
+secret. Restoration is applied at the **last mile** (your screen, your files) and
+**never re-enters the model's context**.
+
+---
+
+## Make it your own
+
+This is a normal, self-contained Python package — **it's yours to run, change,
+and ship privately. You never have to publish it anywhere or run a server.**
+
+- **Customize detection:** the recognizers live in `apii/recognizers/` — edit a
+  regex, tune a checksum, add a country shape.
+- **Swap the NER models:** point `APII_NER_MODEL` / `APII_NER_EN_MODEL` at your
+  own ONNX models, or set `APII_NER_HF_REPO` to your own Hugging Face repo.
+- **Change token formats, policy, vault location** (`APII_HOME`), tenants, etc.
+- **Stay fully offline:** clone, `pip install -e .`, bring the NER models locally
+  — no cloud, no PyPI, no service, ever.
+
+It's built to be forked and made internal. Keep it private; it's yours.
+
+---
+
+## NER models & credit
+
+The bundled models are int8-ONNX redistributions of two open models — **please
+keep crediting the original authors**:
+
+- **Arabic** — [`hatmimoha/arabic-ner`](https://huggingface.co/hatmimoha/arabic-ner)
+  by Hatim Mohamed (on [`asafaya/bert-base-arabic`](https://huggingface.co/asafaya/bert-base-arabic) by Ali Safaya).
+- **English** — [`dslim/bert-base-NER`](https://huggingface.co/dslim/bert-base-NER)
+  by David S. Lim (MIT, CoNLL-2003).
+
+Hosted (quantized) at
+[`aajil-labs-sa/arabic-pii-ner`](https://huggingface.co/aajil-labs-sa/arabic-pii-ner)
+with full provenance + SHAs.
+
+---
+
+## License
+
+**© Aajil Labs.** Dual-licensed — your choice of **MIT** *or* **Apache-2.0**
+(see `LICENSE-MIT` and `LICENSE-APACHE`).
+
+You may use, modify, and redistribute this software (including privately and
+commercially) under either license. **You must keep the copyright and license
+notices** in copies and substantial portions. The bundled NER models are
+redistributed under their original authors' terms — credit them as above.
+
+This is yours to build on — just respect the license.