hlinor-registry 0.4.0__tar.gz

hlinor_registry-0.4.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.

hlinor_registry-0.4.0/PKG-INFO

@@ -0,0 +1,358 @@
+Metadata-Version: 2.4
+Name: hlinor-registry
+Version: 0.4.0
+Summary: Governance and security layer for auditable AI agent systems.
+Author-email: HlinorAI Team <team@hlinor.ai>
+Maintainer-email: HlinorAI Team <team@hlinor.ai>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/HlinorAI/hlinor-agent-registry
+Project-URL: Documentation, https://github.com/HlinorAI/hlinor-agent-registry#readme
+Project-URL: Repository, https://github.com/HlinorAI/hlinor-agent-registry
+Project-URL: Issues, https://github.com/HlinorAI/hlinor-agent-registry/issues
+Project-URL: Changelog, https://github.com/HlinorAI/hlinor-agent-registry/blob/main/CHANGELOG.md
+Keywords: ai,agents,governance,security,policy,compliance,audit,langchain,multi-agent,registry
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+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 :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6.0.0
+Provides-Extra: langchain
+Requires-Dist: langchain>=0.1.0; extra == "langchain"
+Requires-Dist: langchain-openai>=0.1.0; extra == "langchain"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Provides-Extra: all
+Requires-Dist: langchain>=0.1.0; extra == "all"
+Requires-Dist: langchain-openai>=0.1.0; extra == "all"
+Requires-Dist: pytest>=7.0; extra == "all"
+Requires-Dist: pytest-cov>=4.0; extra == "all"
+Dynamic: license-file
+
+# Hlinor Agent Registry
+>  **Latest:** [The OpenAI/Hugging Face Sandbox Escape: Why Declarative AI Governance is No Longer Optional](https://dev.to/ishvan/the-openaihugging-face-sandbox-escape-why-declarative-ai-governance-is-no-longer-optional-4onh) - Dev.to article
+
+Open-source registry layer for auditable AI agent systems. Define what your AI agents may do, validate it before execution, and keep the decision auditable.
+[![Tests](https://github.com/HlinorAI/hlinor-agent-registry/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/HlinorAI/hlinor-agent-registry/actions/workflows/test.yml)
+[![Python 3.10–3.13](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-3776AB.svg)](https://github.com/HlinorAI/hlinor-agent-registry)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+[![PyPI version](https://img.shields.io/pypi/v/hlinor-registry.svg)](https://pypi.org/project/hlinor-registry/)
+[![GitHub stars](https://img.shields.io/github/stars/HlinorAI/hlinor-agent-registry?style=social)](https://github.com/HlinorAI/hlinor-agent-registry)
+
+Define what your AI agents may do, validate it before execution, and keep the
+decision auditable — without replacing the framework that runs your agents.
+
+Hlinor Agent Registry is a declarative governance layer for agent systems. It
+turns action boundaries, policies, approvals, and runtime evidence into
+reviewable YAML contracts that developers and security teams can understand.
+
+## Quickstart
+
+### 1. Install from source
+
+```bash
+git clone https://github.com/HlinorAI/hlinor-agent-registry.git
+cd hlinor-agent-registry
+python -m pip install -e .
+```
+
+Once the package is published, the installation can be shortened to:
+
+```bash
+python -m pip install hlinor-registry
+```
+
+### 2. Declare the source files
+
+Create a `registry.yaml` manifest. Only the files listed here can enter the
+runtime bundle:
+
+```yaml
+version: "1.0"
+policies:
+  - path: "examples/secure_financial_agent.yaml"
+  - path: "examples/budget_limited_research_agent.yaml"
+metadata:
+  environment: "production"
+  compiled_by: "hlinor-registry-cli"
+```
+
+### 3. Compile and enforce
+
+```bash
+hlinor-registry compile \
+  --manifest registry.yaml \
+  --output dist/policy-bundle.json
+```
+
+```python
+from hlinor_registry import PolicyChecker
+
+checker = PolicyChecker("dist/policy-bundle.json")
+decision = checker.check_action("financial-audit-agent", "initiate_transfer")
+
+print(decision.result, decision.reason_code)
+# denied ACTION_BLOCKLISTED_VIOLATED_POLICY_REQUIRE_HUMAN_APPROVAL_FOR_HIGH_VALUE
+```
+
+Compilation validates every listed file, rejects duplicate IDs and path
+traversal, records per-file SHA-256 digests, and writes one authenticated JSON
+bundle. Runtime enforcement reads that bundle only; it never scans a folder.
+
+## Use cases
+
+### Prevent PII leaks
+
+Keep agents that process sensitive data away from external communication and
+make the restriction explicit in a reviewed registry file:
+
+```yaml
+id: financial-audit-agent
+name: Financial Audit Agent
+department: finance
+description: Audits internal financial reports.
+skills: [read_database, anomaly_detection, generate_report]
+validators: [financial-data-validator]
+policies: [no-pii-in-logs, read-only-database-access]
+allowed_actions: [read, analyze, summarize, generate_pdf_report]
+blocked_actions: [send_external_email, delete_records]
+```
+
+The blocklist takes priority over the allowlist:
+
+```python
+decision = checker.check_action(
+    "financial-audit-agent",
+    "send_external_email",
+)
+assert decision.denied
+```
+
+### Block unauthorized actions
+
+Use a strict allowlist for agents that should only perform a narrow set of
+operations. Everything outside the list is denied by `PolicyChecker`:
+
+```python
+decision = checker.check_action("research-agent", "delete_records")
+
+if decision.denied:
+    print(f"Blocked before execution: {decision.reason_code}")
+```
+
+This gives security reviews a concrete answer to the question: “What can this
+agent do?”
+
+### Enforce API budgets and rate limits
+
+Declare budget and rate-limit policies next to the agent's permitted actions.
+Adapters or preflight checks can evaluate these policies before a costly call:
+
+```yaml
+id: web-research-agent
+name: Web Research Agent
+department: marketing
+description: Collects competitor information from public sources.
+skills: [web_search, scrape_public_website, summarize_text]
+validators: [public-source-validator]
+policies:
+  - max_10_searches_per_hour
+  - require_budget_check
+  - block_known_malicious_domains
+allowed_actions: [search, read_public_url, extract_keywords]
+blocked_actions: [login_to_website, submit_forms, call_premium_paid_api]
+metadata:
+  api_budget_limit_usd: 5.00
+```
+
+The registry makes the constraint visible, versionable, and reviewable instead
+of burying it inside one agent implementation.
+
+## Architecture
+
+```mermaid
+flowchart LR
+    A["Developer or security team"] --> B["Explicit registry.yaml manifest"]
+    B --> C["hlinor-registry compile"]
+    C --> D["Authenticated JSON policy bundle"]
+    D --> E["Runtime adapter or PolicyChecker"]
+    E --> F{"Action permitted?"}
+    F -->|Yes| G["Execute tool or skill"]
+    F -->|No| H["Block and record decision"]
+    E --> I["Execution receipts and audit evidence"]
+    I --> J["Review, compliance, and incident response"]
+```
+
+Hlinor sits beside your execution framework. Your agents can continue to run
+in LangChain, CrewAI, or a custom stack while their action boundaries are
+compiled from an explicit, inspectable manifest.
+
+## Hlinor vs. alternatives
+
+| Capability | LangChain | CrewAI | Build it yourself | **Hlinor Registry** |
+| :--- | :--- | :--- | :--- | :--- |
+| Primary role | Agent and tool orchestration | Multi-agent orchestration | Whatever you implement | **Governance and policy layer** |
+| Policy source | Application and tool code | Agent/task configuration | Custom conventions | **Declarative YAML contracts** |
+| Action decisions | Add your own guardrails | Add your own guardrails | Fully custom | **Reusable PolicyChecker and validators** |
+| Runtime boundaries | Framework-dependent | Framework-dependent | Custom | **Allowlist/blocklist patterns and schemas** |
+| Audit model | Build around your stack | Build around your stack | Fully custom | **Audit-ready receipts and evidence schemas** |
+| Works with other frameworks | Not the goal | Not the goal | Depends on design | **Designed to sit beside them** |
+
+Hlinor is not an execution framework. Use it when governance must be explicit,
+reviewable, and portable across the systems that execute your agents.
+
+## Who is this for?
+
+- Platform teams building internal agent infrastructure.
+- Security and compliance teams reviewing agent capabilities.
+- Developers who need a policy boundary before tools cause side effects.
+- Teams operating multiple agents across departments or projects.
+- Open-source maintainers who want YAML examples and automated validation in CI.
+
+## Installation
+
+### From PyPI
+
+The PyPI package will be installable after the first package release:
+
+```bash
+python -m pip install hlinor-registry
+```
+
+The core package requires Python 3.10 or newer and PyYAML. It does not install
+LangChain or another agent framework.
+
+### Optional integrations
+
+```bash
+python -m pip install "hlinor-registry[langchain]"
+```
+
+Then wrap a compatible tool or executor:
+
+```python
+from hlinor_registry.integrations.langchain import GovernedAgent, GovernedTool
+
+safe_tool = GovernedTool(
+    tool=my_langchain_tool,
+    agent_id="research-agent",
+    bundle_path="./dist/policy-bundle.json",
+)
+
+safe_agent = GovernedAgent(
+    agent_executor=my_agent_executor,
+    agent_id="research-agent",
+    bundle_path="./dist/policy-bundle.json",
+)
+```
+
+See [`examples/langchain_integration.py`](examples/langchain_integration.py)
+for a complete example.
+
+### Development dependencies
+
+```bash
+python -m pip install -e ".[dev]"
+python -m pytest
+```
+
+## CLI
+
+Compile an explicit manifest into the authenticated runtime bundle:
+
+```bash
+hlinor-registry compile \
+  --manifest registry.yaml \
+  --output dist/policy-bundle.json
+```
+
+The compiler validates every listed source, rejects duplicate IDs and paths
+outside the manifest directory, and records SHA-256 provenance for each entry.
+The runtime checker accepts the resulting JSON bundle only after verifying its
+overall digest.
+
+Validate a registry file:
+
+```bash
+hlinor-registry validate-agent examples/search-agent.yaml
+```
+
+Validate runtime governance contracts:
+
+```bash
+hlinor-registry validate-execution-context <path>
+hlinor-registry validate-action-preflight <path>
+hlinor-registry validate-capability <path>
+hlinor-registry validate-capability-registration examples/funding_intelligence.yaml
+hlinor-registry validate-protected-resource-boundary <path>
+hlinor-registry validate-evidence-claim <path>
+hlinor-registry validate-circuit-breaker <path>
+```
+
+Inspect a YAML file without changing it:
+
+```bash
+hlinor-registry inspect <path>
+```
+
+## Documentation
+
+### Models and architecture
+
+- [Execution model](docs/execution-model.md)
+- [Approval model](docs/approval-model.md)
+- [Runtime bindings and execution receipts](docs/runtime-receipts.md)
+- [Audit trail](docs/audit-trail.md)
+- [Control Layer architecture](docs/architecture/control-layer-overview.md)
+- [Project isolation](docs/architecture/project-isolation.md)
+- [Task workspace](docs/architecture/task-workspace.md)
+- [Department handoff](docs/architecture/department-handoff.md)
+
+### Governance patterns
+
+- [Production action boundary](docs/patterns/production-action-boundary.md)
+- [Protected resource boundary](docs/patterns/protected-resource-boundary.md)
+- [Preflight before a costly action](docs/patterns/preflight-before-costly-action.md)
+- [Evidence-bound claims](docs/patterns/evidence-bound-claims.md)
+- [Capability verification](docs/patterns/capability-verification.md)
+- [Agent lifecycle operating modes](docs/patterns/agent-lifecycle-operating-modes.md)
+
+## Trust signals
+
+- 41+ automated tests covering compilation, validation, policy enforcement, and integration behavior.
+- GitHub Actions runs the test suite on Python 3.10, 3.11, 3.12, and 3.13.
+- YAML schemas, examples, and governance decisions are designed to be reviewed in pull requests.
+- Licensed under Apache-2.0 for broad open-source and commercial use.
+
+## Community and support
+
+- [Star the repository](https://github.com/HlinorAI/hlinor-agent-registry) if it helps your team.
+- Report bugs or request features through [GitHub Issues](https://github.com/HlinorAI/hlinor-agent-registry/issues).
+- Discuss designs and use cases in [GitHub Discussions](https://github.com/HlinorAI/hlinor-agent-registry/discussions).
+- Read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request.
+- Follow the [Code of Conduct](CODE_OF_CONDUCT.md) when participating.
+
+## Enterprise
+
+Teams adopting agent governance at scale can contact the HlinorAI team at
+`team@hlinor.ai` for architecture guidance, policy design, and integration
+support.
+
+## License
+
+Hlinor Agent Registry is available under the [Apache License 2.0](LICENSE).
+
+## Contributing
+
+Contributions are welcome. Start with an issue or pull request that explains
+the governance problem, the proposed registry contract, and how the behavior
+is tested.