sovereign-shield-ch 0.1.0__tar.gz

sovereign_shield_ch-0.1.0/.gitignore

@@ -0,0 +1,45 @@
+# --- secrets ---
+.env
+.env.*
+!.env.example
+*.pem
+*.key
+
+# --- python ---
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+*.egg
+build/
+dist/
+.Python
+.venv/
+venv/
+.python-version
+
+# --- python tooling caches ---
+.ruff_cache/
+.mypy_cache/
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+
+# --- node / next.js (web/ demo) ---
+node_modules/
+.next/
+out/
+.vercel/
+*.tsbuildinfo
+next-env.d.ts
+
+# --- editor / OS / agent ---
+.vscode/
+.idea/
+.claude/
+.DS_Store
+*.swp
+*.swo
+*~

sovereign_shield_ch-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

sovereign_shield_ch-0.1.0/NOTICE

@@ -0,0 +1,16 @@
+Sovereign Shield
+Copyright 2026 acoseac
+
+This product includes software developed by acoseac and contributors
+under the Apache License, Version 2.0.
+
+Sovereign Shield is an engineering utility for programmatic privacy
+mitigation (deterministic Swiss/EU PII detection and reversible
+tokenization). It is NOT an automated guarantee of regulatory compliance
+under the Swiss Federal Act on Data Protection (FADP) or the EU GDPR, and
+it is not legal advice. Structural, context-independent detection cannot
+catch every leak vector. Use it alongside audit logs, a DPIA where
+required, and human review. See the README for the full disclaimer.
+
+The deterministic detection core is extracted from the K.E.V.I.N.
+adversarial-testing research project.

sovereign_shield_ch-0.1.0/PKG-INFO

@@ -0,0 +1,159 @@
+Metadata-Version: 2.4
+Name: sovereign-shield-ch
+Version: 0.1.0
+Summary: Deterministic, offline Swiss/EU (FADP/GDPR) PII gateway: tokenize personal data before a cloud LLM sees it, restore it on the way back.
+Project-URL: Homepage, https://github.com/acoseac/sovereign-shield
+Project-URL: Repository, https://github.com/acoseac/sovereign-shield
+Project-URL: Issues, https://github.com/acoseac/sovereign-shield/issues
+Project-URL: Live demo, https://shield.ars.md
+Author: acoseac
+License: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: anonymization,compliance,data-sovereignty,fadp,gdpr,llm,pii,privacy,swiss,tokenization
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Provides-Extra: gateway
+Requires-Dist: langchain-core>=0.3; extra == 'gateway'
+Requires-Dist: langchain-google-genai>=2.0; extra == 'gateway'
+Description-Content-Type: text/markdown
+
+# Sovereign Shield
+
+**Use any cloud LLM. Keep the personal data in Switzerland.**
+
+A deterministic, offline gateway for Swiss/EU (FADP / GDPR) personal data. It
+tokenizes structured identifiers **locally** — turning `756.1234.5678.97` into
+`[AHV_1]` — so a prompt can go to Gemini, Claude, or any model without a real
+identifier ever crossing the border, then restores the real values in the reply
+on the way back. Detection is regex + checksum, not ML: zero dependencies, zero
+latency, and it **cannot be talked out of a match**.
+
+> ⚠️ **Disclaimer.** Sovereign Shield is an engineering utility that aids
+> programmatic privacy mitigation. It is **not** an automated guarantee of
+> regulatory compliance under the Swiss Federal Act on Data Protection (FADP) or
+> the EU GDPR, and it is **not legal advice**. Context-dependent leak vectors
+> (free-text names, encoded data, semantics) can still slip past a structural,
+> deterministic layer. Use it alongside a DPIA where required, audit logs, and
+> human review — as the outer, deliberately-dumb layer of a defence-in-depth stack.
+
+[**See it live → shield.ars.md**](https://shield.ars.md) · deterministic, in-browser, no API key.
+
+## Install
+
+```bash
+pip install sovereign-shield-ch              # core: stdlib-only, zero dependencies
+pip install "sovereign-shield-ch[gateway]"   # + the optional LangChain proxy
+```
+
+Requires Python 3.12+.
+
+## Quickstart
+
+```python
+from sovereign_shield import SovereignShield
+
+shield = SovereignShield()
+
+raw = ("Guten Tag. Meine AHV-Nummer ist 756.1234.5678.97. Bitte die Praemie auf "
+       "IBAN CH9300762011623852957 zurueckerstatten. Erreichbar unter "
+       "+41 79 214 88 03 oder hans.muster@bluewin.ch.")
+
+# 1. De-identify locally. `safe` is all that crosses the border.
+safe, ctx = shield.sanitize(raw)
+#   safe -> "Guten Tag. Meine AHV-Nummer ist [AHV_1]. Bitte die Praemie auf
+#            IBAN [IBAN_1] zurueckerstatten. Erreichbar unter [PHONE_1] oder [EMAIL_1]."
+print(ctx.audit())   # {'ch_ahv': 1, 'iban': 1, 'ch_phone': 1, 'email': 1}
+
+# 2. Call any cloud LLM on the placeholders (it never sees a real value).
+answer = call_your_llm(safe)
+
+# 3. Restore the real values locally before serving the user.
+result = shield.rehydrate(answer, ctx)
+print(result.text)       # real AHV / IBAN / phone / email swapped back in
+print(result.clean)      # True if the model didn't mangle a placeholder
+```
+
+`sanitize` is **fail-closed**: if any structured identifier would survive into
+`safe`, it raises `DataLeakError` instead of leaking. `rehydrate` is strict and
+deterministic, and reports any placeholder the model mangled or invented
+(`result.leftover`) so you never ship a broken `[AHV_1` to a user.
+
+### Transparent LangChain proxy
+
+With the `[gateway]` extra, wrap any LangChain chat model and call it as usual —
+sanitize-out and rehydrate-in happen under the hood:
+
+```python
+from langchain_google_genai import ChatGoogleGenerativeAI
+from sovereign_shield.gateway import ShieldedChatModel
+
+llm = ShieldedChatModel(ChatGoogleGenerativeAI(model="gemini-2.5-flash", temperature=0.3))
+
+reply = llm.invoke("Refund AHV 756.1234.5678.97 to IBAN CH9300762011623852957.")
+print(reply.content)                                   # real values restored
+print(reply.additional_kwargs["sovereign_shield"])     # {'kept_on_shore': 2, 'leftover': []}
+```
+
+## What it detects
+
+Deterministic *shape regex + checksum* — the checksum rejects look-alikes so the
+guard never trips on a random 13-digit string. Separators are stripped first, so
+`756.1234.5678.97` and `756 1234 5678 97` validate identically.
+
+| Category | Identifier | Validation |
+|---|---|---|
+| `ch_ahv` | Swiss AHV / AVS number | EAN-13 check digit |
+| `iban` | CH / LI IBAN | ISO-7064 mod-97 |
+| `credit_card` | Card PAN | Luhn |
+| `ch_phone` | Swiss phone | shape only |
+| `email` | Email | shape only |
+| `dob` | Date of birth | off by default (bare dates false-positive) |
+
+**Scope: structured identifiers only.** Person names and street addresses are
+*not* detected — they need an NER model, which would forfeit the deterministic,
+zero-dependency guarantee. Plug your own via `SovereignShield(extra_detectors=[...])`
+(see `SpanDetector`); overlapping spans are dropped fail-closed.
+
+**Not encoding-robust.** A model that base64s or ciphers an identifier defeats the
+regex. Separator/whitespace reformatting is handled; encoding is not.
+
+## How it works
+
+The thesis, proven in the [K.E.V.I.N.](https://github.com/acoseac/kevin) red-team
+research this is extracted from: you can't close a data leak from *inside* the
+model — a jailbreak, a pretext, or a forced output schema will make it disclose.
+So you put a **deterministic, offline boundary** around the model instead. Sovereign
+Shield is that boundary, as a library: detect → tokenize → (model) → restore.
+
+The browser demo ships a TypeScript port of the exact same detectors, kept
+**byte-for-byte in parity** with this Python source by a generated vector suite —
+so redaction on the client and on the server can never silently drift.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest                                        # unit + round-trip suite
+ruff check . && ruff format --check . && mypy
+python scripts/gen_shield_vectors.py --check  # Python parity vectors current
+cd web && npm install && npm run parity       # TS shield reproduces them exactly
+```
+
+The `web/` directory is the live demo (Next.js). See [web/README.md](web/README.md).
+
+## Credits & license
+
+Extracted from the [K.E.V.I.N.](https://github.com/acoseac/kevin) adversarial-testing
+project; background in the [FADP AI-gateway write-up](https://www.ars.md/blog).
+Licensed under [Apache-2.0](LICENSE).

sovereign_shield_ch-0.1.0/README.md

@@ -0,0 +1,129 @@
+# Sovereign Shield
+
+**Use any cloud LLM. Keep the personal data in Switzerland.**
+
+A deterministic, offline gateway for Swiss/EU (FADP / GDPR) personal data. It
+tokenizes structured identifiers **locally** — turning `756.1234.5678.97` into
+`[AHV_1]` — so a prompt can go to Gemini, Claude, or any model without a real
+identifier ever crossing the border, then restores the real values in the reply
+on the way back. Detection is regex + checksum, not ML: zero dependencies, zero
+latency, and it **cannot be talked out of a match**.
+
+> ⚠️ **Disclaimer.** Sovereign Shield is an engineering utility that aids
+> programmatic privacy mitigation. It is **not** an automated guarantee of
+> regulatory compliance under the Swiss Federal Act on Data Protection (FADP) or
+> the EU GDPR, and it is **not legal advice**. Context-dependent leak vectors
+> (free-text names, encoded data, semantics) can still slip past a structural,
+> deterministic layer. Use it alongside a DPIA where required, audit logs, and
+> human review — as the outer, deliberately-dumb layer of a defence-in-depth stack.
+
+[**See it live → shield.ars.md**](https://shield.ars.md) · deterministic, in-browser, no API key.
+
+## Install
+
+```bash
+pip install sovereign-shield-ch              # core: stdlib-only, zero dependencies
+pip install "sovereign-shield-ch[gateway]"   # + the optional LangChain proxy
+```
+
+Requires Python 3.12+.
+
+## Quickstart
+
+```python
+from sovereign_shield import SovereignShield
+
+shield = SovereignShield()
+
+raw = ("Guten Tag. Meine AHV-Nummer ist 756.1234.5678.97. Bitte die Praemie auf "
+       "IBAN CH9300762011623852957 zurueckerstatten. Erreichbar unter "
+       "+41 79 214 88 03 oder hans.muster@bluewin.ch.")
+
+# 1. De-identify locally. `safe` is all that crosses the border.
+safe, ctx = shield.sanitize(raw)
+#   safe -> "Guten Tag. Meine AHV-Nummer ist [AHV_1]. Bitte die Praemie auf
+#            IBAN [IBAN_1] zurueckerstatten. Erreichbar unter [PHONE_1] oder [EMAIL_1]."
+print(ctx.audit())   # {'ch_ahv': 1, 'iban': 1, 'ch_phone': 1, 'email': 1}
+
+# 2. Call any cloud LLM on the placeholders (it never sees a real value).
+answer = call_your_llm(safe)
+
+# 3. Restore the real values locally before serving the user.
+result = shield.rehydrate(answer, ctx)
+print(result.text)       # real AHV / IBAN / phone / email swapped back in
+print(result.clean)      # True if the model didn't mangle a placeholder
+```
+
+`sanitize` is **fail-closed**: if any structured identifier would survive into
+`safe`, it raises `DataLeakError` instead of leaking. `rehydrate` is strict and
+deterministic, and reports any placeholder the model mangled or invented
+(`result.leftover`) so you never ship a broken `[AHV_1` to a user.
+
+### Transparent LangChain proxy
+
+With the `[gateway]` extra, wrap any LangChain chat model and call it as usual —
+sanitize-out and rehydrate-in happen under the hood:
+
+```python
+from langchain_google_genai import ChatGoogleGenerativeAI
+from sovereign_shield.gateway import ShieldedChatModel
+
+llm = ShieldedChatModel(ChatGoogleGenerativeAI(model="gemini-2.5-flash", temperature=0.3))
+
+reply = llm.invoke("Refund AHV 756.1234.5678.97 to IBAN CH9300762011623852957.")
+print(reply.content)                                   # real values restored
+print(reply.additional_kwargs["sovereign_shield"])     # {'kept_on_shore': 2, 'leftover': []}
+```
+
+## What it detects
+
+Deterministic *shape regex + checksum* — the checksum rejects look-alikes so the
+guard never trips on a random 13-digit string. Separators are stripped first, so
+`756.1234.5678.97` and `756 1234 5678 97` validate identically.
+
+| Category | Identifier | Validation |
+|---|---|---|
+| `ch_ahv` | Swiss AHV / AVS number | EAN-13 check digit |
+| `iban` | CH / LI IBAN | ISO-7064 mod-97 |
+| `credit_card` | Card PAN | Luhn |
+| `ch_phone` | Swiss phone | shape only |
+| `email` | Email | shape only |
+| `dob` | Date of birth | off by default (bare dates false-positive) |
+
+**Scope: structured identifiers only.** Person names and street addresses are
+*not* detected — they need an NER model, which would forfeit the deterministic,
+zero-dependency guarantee. Plug your own via `SovereignShield(extra_detectors=[...])`
+(see `SpanDetector`); overlapping spans are dropped fail-closed.
+
+**Not encoding-robust.** A model that base64s or ciphers an identifier defeats the
+regex. Separator/whitespace reformatting is handled; encoding is not.
+
+## How it works
+
+The thesis, proven in the [K.E.V.I.N.](https://github.com/acoseac/kevin) red-team
+research this is extracted from: you can't close a data leak from *inside* the
+model — a jailbreak, a pretext, or a forced output schema will make it disclose.
+So you put a **deterministic, offline boundary** around the model instead. Sovereign
+Shield is that boundary, as a library: detect → tokenize → (model) → restore.
+
+The browser demo ships a TypeScript port of the exact same detectors, kept
+**byte-for-byte in parity** with this Python source by a generated vector suite —
+so redaction on the client and on the server can never silently drift.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest                                        # unit + round-trip suite
+ruff check . && ruff format --check . && mypy
+python scripts/gen_shield_vectors.py --check  # Python parity vectors current
+cd web && npm install && npm run parity       # TS shield reproduces them exactly
+```
+
+The `web/` directory is the live demo (Next.js). See [web/README.md](web/README.md).
+
+## Credits & license
+
+Extracted from the [K.E.V.I.N.](https://github.com/acoseac/kevin) adversarial-testing
+project; background in the [FADP AI-gateway write-up](https://www.ars.md/blog).
+Licensed under [Apache-2.0](LICENSE).

sovereign_shield_ch-0.1.0/RELEASING.md

@@ -0,0 +1,54 @@
+# Releasing
+
+`sovereign-shield-ch` publishes to PyPI via **Trusted Publishing** (OIDC) — no API
+token or secret is stored in the repo. The [`Release`](.github/workflows/release.yml)
+workflow builds the sdist + wheel, runs `twine check --strict`, and uploads
+whenever a **GitHub Release** is published.
+
+## One-time setup (before the first release)
+
+The PyPI project does not exist yet, so register a **pending publisher** at
+<https://pypi.org/manage/account/publishing/> with these exact values:
+
+| Field | Value |
+|---|---|
+| PyPI Project Name | `sovereign-shield-ch` |
+| Owner | `acoseac` |
+| Repository name | `sovereign-shield` |
+| Workflow name | `release.yml` |
+| Environment name | `pypi` |
+
+Then, in the GitHub repo, create an **environment** named `pypi`
+(Settings → Environments → New environment). Optionally add yourself as a
+required reviewer so a publish can't run without a manual approval — the workflow
+already references `environment: pypi`.
+
+(Optional) Register the same as a pending publisher on
+<https://test.pypi.org/manage/account/publishing/> if you want to rehearse
+against TestPyPI first.
+
+## Cutting a release
+
+1. Bump the version — **single source of truth** is `__version__` in
+   [`src/sovereign_shield/__init__.py`](src/sovereign_shield/__init__.py)
+   (hatchling reads it; `pyproject.toml` has no separate version to sync).
+2. Commit and merge to `main` (CI green).
+3. Tag and publish a GitHub Release matching the version:
+   ```bash
+   gh release create v0.1.0 --title v0.1.0 --generate-notes
+   ```
+4. The `Release` workflow runs automatically: build → `twine check --strict` →
+   publish to PyPI via OIDC. Watch it under the **Actions** tab (and approve the
+   `pypi` environment if you enabled a required reviewer).
+
+## Local dry run
+
+Reproduce exactly what CI does, without publishing:
+
+```bash
+pip install -e ".[dev]" build twine
+python -m build
+twine check --strict dist/*
+# inspect the wheel is package-only (no web/ demo):
+python -m zipfile -l dist/*.whl
+```