helixid-sdk-py 0.1.1__tar.gz

helixid_sdk_py-0.1.1/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 2026 DgVerse LLP
+
+   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.

helixid_sdk_py-0.1.1/PKG-INFO

@@ -0,0 +1,260 @@
+Metadata-Version: 2.4
+Name: helixid-sdk-py
+Version: 0.1.1
+Summary: Python SDK for HelixID -- decentralized agent identity via DID/VC.
+Author: DgVerse LLP
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/helixid/helix-sdk-py
+Project-URL: Repository, https://github.com/helixid/helix-sdk-py
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pynacl<2.0,>=1.5
+Requires-Dist: cryptography>=41.0
+Requires-Dist: requests>=2.31
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4; extra == "dev"
+Requires-Dist: pytest-cov>=4.1; extra == "dev"
+Requires-Dist: langchain-core>=0.3; python_version >= "3.10" and extra == "dev"
+Requires-Dist: crewai>=1.0; python_version >= "3.10" and extra == "dev"
+Provides-Extra: mcp-middleware
+Requires-Dist: mcp<2,>=1.9; python_version >= "3.10" and extra == "mcp-middleware"
+Provides-Extra: langchain
+Requires-Dist: langchain-core>=0.3; python_version >= "3.10" and extra == "langchain"
+Provides-Extra: crewai
+Requires-Dist: crewai>=1.0; python_version >= "3.10" and extra == "crewai"
+Provides-Extra: all
+Requires-Dist: mcp<2,>=1.9; python_version >= "3.10" and extra == "all"
+Requires-Dist: langchain-core>=0.3; python_version >= "3.10" and extra == "all"
+Requires-Dist: crewai>=1.0; python_version >= "3.10" and extra == "all"
+Dynamic: license-file
+
+# helixid-sdk-py
+
+Python SDK for [HelixID](https://github.com/helixid/helixid) -- decentralized
+agent identity via DID/VC standards (did:hedera, did:key, did:web), delegation,
+and Verifiable Presentation verification.
+
+This is the Python counterpart to
+[`helix-sdk-js`](https://github.com/helixid/helix-sdk-js), following the same
+**SDK-API-only** architecture (see `docs/proposal-sdk-api-only.md` and
+`docs/proposal-retire-core-package.md` in the `helixid/helixid` repo): every
+SDK, in every language, depends only on the HelixID API -- never on a shared
+"core" package -- except for private-key operations that must stay local:
+keygen, sign, canonical-hash and `VPBuilder.sign()`, which issuers and Service
+Providers still use to sign with their own keys. Verification, delegation-VC
+construction, DID resolution, and status checks are all API calls made through
+`HelixClient`.
+
+**Agents hold no keys.** Agent self-custody has been retired: the server
+generates an agent's keypair during onboarding and holds the private key, so
+onboarding, presenting and delegating are all API calls
+(`onboard_agent()`, `sign_vp()`, `delegate_authority()`).
+
+## Documentation
+
+Full documentation is at **[docs.helixid.dev](https://docs.helixid.dev)** — concepts,
+guides, and reference. This README covers only what is specific to this repository.
+
+| | |
+|---|---|
+| **Start here** | [Introduction](https://docs.helixid.dev/) |
+| **Concepts** | [The Trust Stack](https://docs.helixid.dev/concepts/trust-stack) · [Two-Issuer Model](https://docs.helixid.dev/concepts/two-issuer-model) · [Delegation](https://docs.helixid.dev/concepts/delegation) · [Revocation](https://docs.helixid.dev/concepts/revocation) |
+| **Get started** | [Quick Start](https://docs.helixid.dev/get-started/quick-start) · [Installation & Modes](https://docs.helixid.dev/get-started/installation-and-modes) |
+| **Contributing** | [How to Contribute](https://docs.helixid.dev/contributing/how-to-contribute) · [`CONTRIBUTING.md`](CONTRIBUTING.md) |
+| **Security** | [Reporting a Vulnerability](https://docs.helixid.dev/security/reporting-a-vulnerability) · [`SECURITY.md`](SECURITY.md) |
+
+---
+
+## Status: v0.1.0, early
+
+This is the first release. Core local-signing primitives and the full
+`HelixClient` API surface are implemented and tested; a few areas are
+still gaps -- see [Known gaps](#known-gaps) below.
+
+## Install
+
+```bash
+pip install helixid-sdk-py
+```
+
+Or from source:
+
+```bash
+pip install -e .
+```
+
+## Cross-language parity
+
+The local-signing primitives (`keys.py`, `vp_crypto.py`, `proof.py`,
+`vp_builder.py`) are verified **byte-for-byte** against the same
+`fixtures/golden-vectors/*.json` fixtures that `helix-sdk-js` and
+`helix-core` assert against -- same private key, same payload, same
+signature, same base58btc-encoded proof value, in every language. See
+`tests/test_golden_vectors.py` and `fixtures/golden-vectors/README.md`.
+
+If you regenerate the vectors in `helix-server` (`pnpm generate:golden-vectors`),
+re-copy the three JSON files here too, the same way `helix-sdk-js` does.
+
+## Packages in this repo
+
+- **`helix_sdk`** -- core SDK (see Quick example below).
+- **`helix_mcp_middleware`** -- Model Context Protocol integration:
+  server-side VP verification middleware and client-side VP attachment.
+  Install with the `mcp-middleware` extra:
+  `pip install helixid-sdk-py[mcp-middleware]`.
+- **`helix_langchain`** -- LangChain integration: a tool wrapper that
+  injects a signed VP into every tool call, plus scope-based tool
+  filtering. Install with `pip install helixid-sdk-py[langchain]`.
+- **`helix_crewai`** -- CrewAI integration, following the same pattern as
+  `helix_langchain`. There is no CrewAI counterpart in `helix-sdk-js` --
+  this is Python-only. Install with `pip install helixid-sdk-py[crewai]`.
+
+Install everything at once with `pip install helixid-sdk-py[all]`.
+
+## Quick example
+
+```python
+from helix_sdk import HelixClient
+
+client = HelixClient(
+    "https://your-helix-api.example.com",
+    admin_api_key="...",  # signing is admin-gated in OSS
+)
+
+# The enrollment token is minted beforehand by the agent's owner
+# (POST /v1/enrollment-tokens) -- not by the agent itself.
+onboarding = client.onboard_agent(token, ["https://agent.example.com"])
+agent_did = onboarding["agentDid"]
+
+# Signing is an API call: the caller never has the agent's private key.
+vp = client.sign_vp(agent_did, "https://api.example.com/v1/tools/orders")
+
+result = client.verify_vp(vp)
+print(result["valid"], result["effectiveScopes"])
+```
+
+See `examples/verify_vp_demo.py` for this flow end to end, including scope
+checks and a revoked-credential rejection.
+
+## Examples
+
+See `examples/`:
+
+- `verify_vp_demo.py` -- onboards an agent with `onboard_agent()`, signs a VP
+  through `sign_vp()`, verifies it, exercises `check_scope()`/`require_scope()`,
+  then revokes the VC and shows the next verification attempt fail with
+  `VC_REVOKED`.
+- `agent_delegation_demo.py` -- onboards a delegator and a sub-agent, delegates
+  a scope subset with `delegate_authority()`, has the sub-agent present the
+  delegated credential, and shows a further delegation being refused because
+  the sub-agent has no delegation authority of its own.
+
+Both require a running `helix-api` instance:
+
+```bash
+HELIX_API_URL=http://127.0.0.1:3579 \
+HELIX_ADMIN_API_KEY=your-admin-key \
+python examples/agent_delegation_demo.py
+```
+
+The TypeScript side has since been migrated too: `helixid`'s
+`examples/delegation-demo.ts` and its live integration test
+(`tests/live/agent-delegation.live.integration.test.ts`) both use
+`delegateAuthority()` -- the server signs on the delegator's behalf, since no
+caller holds an agent's key any more. `delegate_authority()` here is the
+Python equivalent.
+
+## CLI
+
+There is no Python CLI. Platform-operator workflows (DID/wallet/status-list/
+VC lifecycle) are covered by `helix-sdk-js`'s `cli` package -- see
+`docs/decision-cli-mcp-scope.md` in the `helixid/helixid` repo for why the
+CLI has a single canonical implementation rather than one per SDK language.
+
+## Testing
+
+```bash
+pip install -e ".[dev,all]"
+pytest
+```
+
+`pytest` always runs with coverage (`[tool.pytest.ini_options]` in
+`pyproject.toml`) and fails under 60% -- the measured baseline as of
+2026-09-03, not a target. `helix-sdk-js`/`helix-api` enforce 90%
+lines/statements, 85% branches, 90% functions; closing this gap (some
+modules, like `did.py`, currently have no direct unit tests at all) is
+real follow-up work, not something this tooling change did on its own.
+
+- `tests/test_golden_vectors.py` -- cross-language crypto parity (no network).
+- `tests/test_delegation_flow_mocked.py` -- exercises the full
+  `delegate()` / `VPBuilder` / wallet flow against a mocked HTTP layer that
+  faithfully reproduces helix-api's real prepare/finalize contract,
+  including asserting the delegator's private key never appears in any
+  outgoing request body.
+- `tests/test_framework_adapters.py` -- exercises `helix_mcp_middleware`,
+  `helix_langchain`, and `helix_crewai` against the real installed
+  `langchain-core` and `crewai` packages (not mocks of them), so a real
+  interface drift in either framework would fail these tests. Skips
+  gracefully on Python < 3.10, since both frameworks require it.
+
+There is currently no automated **live** integration test against a real
+`helix-api` instance in this repo's CI (see Known gaps) -- if you have a
+running instance, you can exercise the real network path with the two
+example scripts above.
+
+## Known gaps
+
+- **No live network integration test yet.** The mocked tests above verify
+  the SDK's logic faithfully, but nothing here has been run against a real,
+  live `helix-api` process end-to-end. (The sandbox used to build this SDK
+  could not start one -- `helix-api`'s `server.ts` imports the generated
+  Prisma client unconditionally, even in SQLite storage mode, and `prisma
+  generate` needs network access to `binaries.prisma.sh`, which was outside
+  that environment's egress allowlist. This is a sandbox-only limitation,
+  not a code issue, and shouldn't block real CI or local development where
+  Prisma can actually run.) Running the two example scripts against a real
+  instance is the recommended way to close this gap.
+- **`HttpAdapter` is synchronous** (built on `requests`), unlike
+  `helix-sdk-js`'s async `fetch`-based adapter. This was a deliberate v0
+  choice -- most Python agent/automation call sites are synchronous -- not
+  an oversight; an async variant can be added later without breaking this
+  one.
+- **No `did:hedera` package yet.** DID resolution generally is always an
+  API call in this architecture (per `docs/proposal-sdk-api-only.md`), so
+  this is really about offline Hedera anchoring specifically, which
+  `helix-sdk-js`'s `cli` package supports via a separate `did-hedera`
+  package this repo hasn't ported. Since the CLI itself is JS-only (see
+  `docs/decision-cli-mcp-scope.md`), this gap only matters if this SDK's
+  own local-signing primitives grow a `did:hedera` creation path.
+- **No `widget` package** (helix-sdk-js's browser-embeddable consent
+  widget has no obvious Python equivalent and hasn't been attempted).
+- **`HelixIDCallbackHandler` in `helix_langchain` cannot rewrite tool
+  input before execution** -- documented in its own docstring. LangChain
+  Python's `on_tool_start` callback is a notification hook, not an
+  interceptor (unlike the JS SDK's bespoke `RunnableConfigLike.
+  handleToolStart`, which really can mutate input first). Real VP
+  injection happens through `helix_id_tool_wrapper()` instead; the
+  callback handler is offered for observability/wallet-warming only. This
+  is a genuine LangChain Python API constraint, not an incomplete port.
+- **Version numbering does not yet track `helix-sdk-js`'s version.** Per
+  `docs/decision-sdk-py-scope.md`, this SDK's version should track the JS
+  SDK's; that mapping strategy hasn't been decided yet, so this starts at
+  `0.1.0` independently.
+
+## The HelixID ecosystem
+
+| Repository | What it is |
+|---|---|
+| [helixid](https://github.com/helixid/helixid) | HelixID API — the issuer and verifier service |
+| [helix-core](https://github.com/helixid/helix-core) | `@helixid/core` — crypto, schemas, resolver, verification primitives |
+| [helix-sdk-js](https://github.com/helixid/helix-sdk-js) | JS/TS SDK, CLI, LangChain + MCP middleware, consent widget |
+| **helix-sdk-py** — you are here | `helixid-sdk-py` — the Python SDK |
+| [helix-console](https://github.com/helixid/helix-console) | Operator Console SPA |
+| [helix-wiki](https://github.com/helixid/helix-wiki) | Source for [docs.helixid.dev](https://docs.helixid.dev) |
+
+---
+
+## License
+
+Apache-2.0