guardex-ai 0.1.0__tar.gz

guardex_ai-0.1.0/CHANGELOG.md

@@ -0,0 +1,69 @@
+# Changelog
+
+All notable changes to GuardEx are documented in this file. The format
+follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the
+project tries to follow [Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-07-08
+
+First public open-source release.
+
+### Added
+
+- `Guard` - single-class entry point for screening text at any of 8
+  semantic gates (`input`, `prompt`, `output`, `tool_input`, `tool_output`,
+  `retrieval_query`, `retrieval_result`, `stream`).
+- Local in-process ML pipeline (`LocalRunner`): input validation, keyword
+  gate, Unicode/leet normalization, ONNX safety classifier, GLiNER PII
+  detection (31 entity types), embedding topic scope, custom safety
+  routes, optional Ollama LlamaGuard cascade, optional NLI grounding.
+- `GuardExPolicy` - single dataclass for every screening knob, with
+  `from_yaml()` loader and per-context resolution via
+  `CachedPolicyResolver`.
+- `PIIVault` - reversible PII tokenization with `restore()` mapping
+  vault tokens back to original values; ships a default system-prompt
+  hint to teach LLMs to use tokens naturally.
+- `InjectionDetector` - regex-based prompt-injection + jailbreak
+  detector with `extra_patterns` extension point and severity property.
+- `ConversationGuard` - sliding-window screening that detects
+  multi-turn escalation patterns the per-turn classifier would miss.
+- `SafetyRouteEngine` - user-defined blocklist categories via example
+  utterances with cosine-similarity matching.
+- Async API surface (`ascreen`, `ascreen_batch`, `acheck_grounding`,
+  `ascreen_grounded`, `astream`) that bridges to sync in local mode.
+- OpenTelemetry instrumentation (`screening_span`, `record_result`)
+  and structured audit logging via the `guardex.audit` logger.
+- Real-time telemetry dashboard at `http://localhost:7865` via
+  `guardex-dashboard` CLI or `start_dashboard()`.
+- LangChain integration: `GuardedLLM` (full-pipeline wrap) and
+  `GuardExCallbackHandler` (callback-based screening).
+- Streaming PII vault restoration via
+  `Guard.astream(..., vault=..., restore_mode="buffered"|"stream-safe")`.
+
+### Default configuration
+
+- `pii_threshold = 0.85` (calibrated for GLiNER, keeps real-PII recall
+  near 100% while excluding the 0.6-0.8 false-positive band).
+- `DEFAULT_PII_ALLOW_LIST` ships 21 conversational tokens (hi, hello,
+  ok, ...) as defense-in-depth.
+- `block_on_unsafe_input = True`, `block_on_unsafe_output = True`.
+- `cascade_mode = "safety"` (auto-downgrades to `"speed"` at boot if
+  Ollama is not reachable).
+- `grounding_enabled = False` (opt-in; enabling adds a ~700 MB NLI
+  model download).
+- Block-by-default categories: S1 (Violent Crimes), S3 (Sex-Related
+  Crimes), S4 (Child Sexual Exploitation), S9 (Indiscriminate Weapons),
+  S11 (Suicide & Self-Harm).
+
+### Known limitations
+
+- Cross-lingual safety classification (English-only patterns).
+- Image / audio / video moderation not in scope.
+- GCG adversarial suffix attacks and many-shot jailbreaking are
+  industry-wide unsolved problems.
+- A separate self-hosted server distribution is not included.
+
+[Unreleased]: https://github.com/atliq/guardex-ai/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/atliq/guardex-ai/releases/tag/v0.1.0

guardex_ai-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,99 @@
+# Contributing to GuardEx
+
+Thank you for considering contributing to GuardEx! This document provides guidelines for contributing to the project.
+
+## Getting Started
+
+### Prerequisites
+
+- Python 3.10+
+- Git
+
+### Development Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/atliq/guardex-ai.git
+cd guardex
+
+# Create a virtual environment
+python -m venv .venv
+source .venv/bin/activate  # Linux/macOS
+# .venv\Scripts\activate   # Windows
+
+# Install SDK in development mode with all optional extras
+pip install -e ".[dev,local]"
+
+# Run SDK tests
+pytest tests/ -v
+```
+
+## How to Contribute
+
+### Reporting Bugs
+
+1. Check [existing issues](https://github.com/atliq/guardex-ai/issues) to avoid duplicates
+2. Use the bug report template when creating a new issue
+3. Include: Python version, SDK version, steps to reproduce, expected vs actual behavior
+
+### Suggesting Features
+
+1. Open a GitHub issue with the "feature request" label
+2. Describe the use case and expected behavior
+3. If possible, include example API usage
+
+### Submitting Pull Requests
+
+1. **Fork** the repository and create a feature branch from `main`
+2. **Link** your PR to an existing issue (or create one first for features)
+3. **Write tests** for any new functionality
+4. **Run the test suite** before submitting:
+   ```bash
+   pytest tests/ -v
+   ```
+5. **Follow the code style**: we use `black` for formatting and `ruff` for linting
+6. **Update documentation** if your change affects the public API
+7. **Keep PRs focused** - one feature or fix per PR
+
+### Code Style
+
+- **Formatting**: `black` with default settings
+- **Linting**: `ruff` with default settings
+- **Type hints**: Required for all public API functions
+- **Docstrings**: Required for all public classes and methods (Google style)
+- **Tests**: Required for all new features and bug fixes
+
+### Commit Messages
+
+- Use clear, descriptive commit messages
+- Start with a verb: "Add", "Fix", "Update", "Remove"
+- Reference issue numbers: "Fix #123: handler tuple unpacking bug"
+
+## Project Structure
+
+```
+guardex/
+├── guardex/          # Client SDK (pip installable)
+│   ├── guard.py          # Main Guard class
+│   ├── client.py         # HTTP client
+│   ├── policy.py         # Policy configuration
+│   └── ...
+├── tests/                # SDK test suite
+└── docs/                 # Documentation (guides, notebooks, SDK reference)
+```
+
+## Branch Strategy
+
+This project uses **`main`** as the default branch. Open PRs against `main`.
+
+- Create a topic branch off `main` (e.g. `feat/pii-regex`, `fix/handler-tuple`).
+- Keep PRs small and focused - one feature or fix per PR.
+- Rebase (don't merge) `main` into your branch before requesting review.
+
+## Security
+
+If you discover a security vulnerability, **do NOT open a public issue**. Please see [SECURITY.md](SECURITY.md) for responsible disclosure instructions.
+
+## License
+
+By contributing to GuardEx, you agree that your contributions will be licensed under the [Apache License 2.0](LICENSE).

guardex_ai-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 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 the 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 the 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 any 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
+
+   Copyright 2026 GuardEx
+
+   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.

guardex_ai-0.1.0/MANIFEST.in

@@ -0,0 +1,38 @@
+include LICENSE
+include README.md
+include CHANGELOG.md
+include CONTRIBUTING.md
+include SECURITY.md
+include guardex.yaml.example
+include pyproject.toml
+recursive-include guardex *.py py.typed
+recursive-include guardex/dashboard_assets *.html *.css *.js
+
+# Defense-in-depth excludes: these directories should never end up in the
+# sdist/wheel, even if someone accidentally adds them to the package tree.
+recursive-exclude guardex-server *
+prune builddocs
+recursive-exclude tests *
+recursive-exclude docs *
+recursive-exclude demos *
+recursive-exclude examples *
+recursive-exclude MEMORY *
+recursive-exclude Plans *
+recursive-exclude internal-docs *
+recursive-exclude beta_chat *
+exclude TASKS.md
+exclude CLAUDE.md
+exclude KNOGEN_INTEGRATION_REPORT.md
+exclude KNOGEN_INTEGRATION_REPORT_V2.md
+exclude PLACEHOLDERS_TO_FILL.md
+exclude AUDIT_FINDINGS.md
+exclude .mcp.json
+exclude .env
+
+# Standard build hygiene
+recursive-exclude * __pycache__
+recursive-exclude * *.py[cod]
+recursive-exclude * .env
+recursive-exclude * .env.*
+recursive-exclude * .DS_Store
+recursive-exclude * Thumbs.db