unitares-sdk 0.1.0__tar.gz

unitares_sdk-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 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
+
+   Copyright 2025-2026 Kenny Wang (CIRWEL Systems)
+
+   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.

unitares_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,196 @@
+Metadata-Version: 2.4
+Name: unitares-sdk
+Version: 0.1.0
+Summary: Agent SDK for UNITARES governance — check-in loop, EISV state, identity anchors, and lease-plane client for long-lived AI agents
+Author: cirwel
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/cirwel/unitares
+Project-URL: Documentation, https://github.com/cirwel/unitares/blob/master/agents/sdk/README.md
+Project-URL: Source, https://github.com/cirwel/unitares
+Project-URL: Issues, https://github.com/cirwel/unitares/issues
+Keywords: ai-agents,governance,mcp,multi-agent-systems,observability
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx<1.0.0,>=0.27.0
+Requires-Dist: mcp<2.0.0,>=1.26.0
+Requires-Dist: pydantic<3.0.0,>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest<10.0.0,>=7.4.0; extra == "dev"
+Requires-Dist: pytest-asyncio<2.0.0,>=0.21.0; extra == "dev"
+Dynamic: license-file
+
+# unitares-sdk
+
+Build your own Unitares resident agent. A resident is a long-running (or
+scheduled) process that checks in to governance, carries an EISV state
+vector, and participates in the shared knowledge graph. Vigil, Sentinel,
+and Chronicler are reference implementations.
+
+## Install
+
+```bash
+pip install unitares-sdk
+```
+
+To install the SDK as it shipped with a specific server release, use the Git
+URL instead:
+
+```bash
+pip install "unitares-sdk @ git+https://github.com/cirwel/unitares@v2.17.0#subdirectory=agents/sdk"
+```
+
+Replace `@v2.17.0` with another server release tag only after checking the
+[compatibility map](https://github.com/cirwel/unitares/blob/master/COMPATIBILITY.md).
+Pin a commit SHA when reproducing a specific development build.
+
+Or from a checkout of the [unitares repo](https://github.com/cirwel/unitares):
+
+```bash
+pip install -e agents/sdk
+```
+
+> **Releases are tag-driven.** Pushing an `sdk-v*` tag whose version matches
+> `version` in `pyproject.toml` runs `.github/workflows/publish-sdk.yml`, which
+> builds and uploads via PyPI Trusted Publishing — OIDC, no API token. The SDK
+> carries its own version series, independent of the server's. See the
+> [release process](https://github.com/cirwel/unitares/blob/master/docs/operations/RELEASE_PROCESS.md).
+
+Links in this file are absolute on purpose: `pyproject.toml` uses it as the
+package `readme`, so PyPI renders it outside the repo and relative paths 404.
+
+The package is standalone — it talks to a UNITARES server over MCP/REST and
+never needs the server codebase importable. Fully typed (`py.typed`).
+
+## The 30-line resident
+
+```python
+from pathlib import Path
+from unitares_sdk.agent import CycleResult, GovernanceAgent
+from unitares_sdk.client import GovernanceClient
+
+
+class MyResident(GovernanceAgent):
+    def __init__(self):
+        super().__init__(
+            name="MyResident",
+            mcp_url="http://127.0.0.1:8767/mcp/",
+            persistent=True,               # protects from auto-archive
+            refuse_fresh_onboard=True,     # explicit bootstrap required
+            cycle_timeout_seconds=60.0,    # hard cap on one cycle
+            log_file=Path("/tmp/my_resident.log"),
+            max_log_lines=10_000,
+        )
+
+    async def run_cycle(self, client: GovernanceClient) -> CycleResult | None:
+        # Do your work here. Return a CycleResult to trigger a check-in,
+        # or None to skip (useful for "nothing to do this tick" paths).
+        count = await self.do_scan(client)
+        if count == 0:
+            return None
+        return CycleResult(
+            summary=f"scanned {count} items",
+            complexity=0.2,
+            confidence=0.9,
+        )
+
+
+if __name__ == "__main__":
+    import asyncio
+    asyncio.run(MyResident().run_forever(interval=60))
+```
+
+First run: `UNITARES_FIRST_RUN=1 python my_resident.py` — this mints
+the identity and stores its UUID anchor at
+`~/.unitares/anchors/myresident.json`. Every subsequent run resumes
+that anchor automatically. Never delete anchors: if you do, set
+`UNITARES_FIRST_RUN=1` again to re-bootstrap (you will get a new UUID).
+
+## Extension points
+
+The base class handles MCP connect, identity resolve, check-in,
+heartbeat, log rotation, state persistence, and graceful shutdown.
+Override these to extend behavior:
+
+| Hook | When | Signature | Return |
+|---|---|---|---|
+| `run_cycle(client)` | Each iteration. The only required override. | `(client) -> CycleResult \| None` | `CycleResult` or `None` |
+| `on_after_checkin(client, checkin_result, cycle_result)` | After each check-in, even on pause/reject. Use for EISV logging, coherence tracking, state writes that need the server response. | All three args typed via `unitares_sdk.models`. | `None` |
+| `on_verdict_pause(client, checkin_result, cycle_result)` | When the server returns a `pause` verdict. Use for self-recovery. | Same arg signature as `on_after_checkin` for consistency. | `True` to retry the check-in once; `False` to let `VerdictError` propagate. |
+
+Hook exceptions are logged and swallowed — a broken hook cannot take
+down a cycle. `asyncio.CancelledError` always propagates.
+
+Do **not** override `_ensure_identity`, `_handle_cycle_result`, or
+`_send_heartbeat` — those are load-bearing and change across versions.
+
+## Constructor reference
+
+| Parameter | Type | Default | Purpose |
+|---|---|---|---|
+| `name` | `str` | required | Agent display name; drives anchor path (`~/.unitares/anchors/<name_lower>.json`). |
+| `mcp_url` | `str` | `http://127.0.0.1:8767/mcp/` | Governance MCP endpoint. |
+| `persistent` | `bool` | `False` | Stamp the `persistent` + `autonomous` tags on fresh onboard. Set `True` for long-running residents. |
+| `refuse_fresh_onboard` | `bool` | `False` | Require `UNITARES_FIRST_RUN=1` to mint a new identity. Set `True` to prevent silent ghost-forks. |
+| `cycle_timeout_seconds` | `float \| None` | `None` | Hard cap on a single `run_once` / `run_forever` iteration. MCP's anyio task group can hang on `session.initialize` if the server flakes — use 60–120s. |
+| `log_file` | `Path \| None` | `None` | Log file to auto-trim after each cycle (in both `run_once` and `run_forever`, in a `finally` block so it fires on error and timeout too). Leave unset if launchd / logrotate owns rotation. |
+| `max_log_lines` | `int` | `10_000` | Trim threshold for `log_file`. |
+| `state_dir` | `Path \| None` | `<repo>/data/<name_lower>` | Default directory for state persistence. Used when `state_file` is not set. |
+| `state_file` | `Path \| None` | `None` | Explicit cross-cycle state path. Takes precedence over `state_dir / "state.json"` when set. |
+| `parent_agent_id` | `str \| None` | `None` | Forked-from UUID. Forwards to server on fresh onboard. |
+| `spawn_reason` | `str \| None` | `None` | Registered values: `subagent`, `dialectic_reviewer`, `dispatch`, `compaction`, `explicit`, `new_session`. Unknown values are accepted but receive no live-parent exemption. |
+
+## Lifecycle shapes
+
+- **Daemon:** `asyncio.run(agent.run_forever(interval=60))` — loops
+  forever with heartbeats when idle. Reference:
+  `agents/sentinel/agent.py`.
+- **Scheduled:** `asyncio.run(agent.run_once())` under launchd /
+  systemd cron. References: `agents/chronicler/agent.py`,
+  `agents/vigil/agent.py`.
+
+Both shapes respect `cycle_timeout_seconds` and auto-trim `log_file`.
+
+## State persistence
+
+- `self.save_state(d: dict)` and `self.load_state() -> dict` let your
+  `run_cycle` carry data across iterations. Writes are atomic
+  (`os.replace`).
+- Non-JSON-serializable values (e.g. `datetime`, `Path`) are coerced
+  to their `str()` representation on save rather than raising
+  `TypeError`. You get a lossy round-trip, not a silent state-write
+  failure.
+
+## Identity rules
+
+1. The agent's first MCP call (`onboard` or `identity`) is the sole
+   source of identity. Do not set identity out-of-band.
+2. UUID is the ground truth. `client_session_id` and
+   `continuity_token` are cache keys for ephemeral clients; residents
+   don't need them.
+3. Anchors live at `~/.unitares/anchors/<name_lower>.json`. One
+   anchor per host per role. The file contains `agent_uuid` and is
+   written atomically.
+4. Never silent-swap an identity. If the anchor is missing and
+   `refuse_fresh_onboard=True`, `_ensure_identity` raises
+   `IdentityBootstrapRefused` — the operator must explicitly set
+   `UNITARES_FIRST_RUN=1` once to mint a new one.
+
+## Not in the SDK (on purpose)
+
+- `agents/common/findings.py` and `agents/common/config.py` are
+  internal to the reference residents in this repo. If you need
+  findings-posting in your own resident, vendor the helper or POST to
+  `/api/findings` yourself — the REST contract is the public surface.
+- The violation taxonomy is server-owned vocabulary
+  (`src/violation_taxonomy.yaml`); consume it via the `/v1/taxonomy`
+  endpoint rather than importing server code.
+- Watcher (`agents/watcher/agent.py`) uses a different execution
+  model (sync, hook-driven, one-shot per tool-use event) and does not
+  subclass `GovernanceAgent`.

unitares_sdk-0.1.0/README.md

@@ -0,0 +1,168 @@
+# unitares-sdk
+
+Build your own Unitares resident agent. A resident is a long-running (or
+scheduled) process that checks in to governance, carries an EISV state
+vector, and participates in the shared knowledge graph. Vigil, Sentinel,
+and Chronicler are reference implementations.
+
+## Install
+
+```bash
+pip install unitares-sdk
+```
+
+To install the SDK as it shipped with a specific server release, use the Git
+URL instead:
+
+```bash
+pip install "unitares-sdk @ git+https://github.com/cirwel/unitares@v2.17.0#subdirectory=agents/sdk"
+```
+
+Replace `@v2.17.0` with another server release tag only after checking the
+[compatibility map](https://github.com/cirwel/unitares/blob/master/COMPATIBILITY.md).
+Pin a commit SHA when reproducing a specific development build.
+
+Or from a checkout of the [unitares repo](https://github.com/cirwel/unitares):
+
+```bash
+pip install -e agents/sdk
+```
+
+> **Releases are tag-driven.** Pushing an `sdk-v*` tag whose version matches
+> `version` in `pyproject.toml` runs `.github/workflows/publish-sdk.yml`, which
+> builds and uploads via PyPI Trusted Publishing — OIDC, no API token. The SDK
+> carries its own version series, independent of the server's. See the
+> [release process](https://github.com/cirwel/unitares/blob/master/docs/operations/RELEASE_PROCESS.md).
+
+Links in this file are absolute on purpose: `pyproject.toml` uses it as the
+package `readme`, so PyPI renders it outside the repo and relative paths 404.
+
+The package is standalone — it talks to a UNITARES server over MCP/REST and
+never needs the server codebase importable. Fully typed (`py.typed`).
+
+## The 30-line resident
+
+```python
+from pathlib import Path
+from unitares_sdk.agent import CycleResult, GovernanceAgent
+from unitares_sdk.client import GovernanceClient
+
+
+class MyResident(GovernanceAgent):
+    def __init__(self):
+        super().__init__(
+            name="MyResident",
+            mcp_url="http://127.0.0.1:8767/mcp/",
+            persistent=True,               # protects from auto-archive
+            refuse_fresh_onboard=True,     # explicit bootstrap required
+            cycle_timeout_seconds=60.0,    # hard cap on one cycle
+            log_file=Path("/tmp/my_resident.log"),
+            max_log_lines=10_000,
+        )
+
+    async def run_cycle(self, client: GovernanceClient) -> CycleResult | None:
+        # Do your work here. Return a CycleResult to trigger a check-in,
+        # or None to skip (useful for "nothing to do this tick" paths).
+        count = await self.do_scan(client)
+        if count == 0:
+            return None
+        return CycleResult(
+            summary=f"scanned {count} items",
+            complexity=0.2,
+            confidence=0.9,
+        )
+
+
+if __name__ == "__main__":
+    import asyncio
+    asyncio.run(MyResident().run_forever(interval=60))
+```
+
+First run: `UNITARES_FIRST_RUN=1 python my_resident.py` — this mints
+the identity and stores its UUID anchor at
+`~/.unitares/anchors/myresident.json`. Every subsequent run resumes
+that anchor automatically. Never delete anchors: if you do, set
+`UNITARES_FIRST_RUN=1` again to re-bootstrap (you will get a new UUID).
+
+## Extension points
+
+The base class handles MCP connect, identity resolve, check-in,
+heartbeat, log rotation, state persistence, and graceful shutdown.
+Override these to extend behavior:
+
+| Hook | When | Signature | Return |
+|---|---|---|---|
+| `run_cycle(client)` | Each iteration. The only required override. | `(client) -> CycleResult \| None` | `CycleResult` or `None` |
+| `on_after_checkin(client, checkin_result, cycle_result)` | After each check-in, even on pause/reject. Use for EISV logging, coherence tracking, state writes that need the server response. | All three args typed via `unitares_sdk.models`. | `None` |
+| `on_verdict_pause(client, checkin_result, cycle_result)` | When the server returns a `pause` verdict. Use for self-recovery. | Same arg signature as `on_after_checkin` for consistency. | `True` to retry the check-in once; `False` to let `VerdictError` propagate. |
+
+Hook exceptions are logged and swallowed — a broken hook cannot take
+down a cycle. `asyncio.CancelledError` always propagates.
+
+Do **not** override `_ensure_identity`, `_handle_cycle_result`, or
+`_send_heartbeat` — those are load-bearing and change across versions.
+
+## Constructor reference
+
+| Parameter | Type | Default | Purpose |
+|---|---|---|---|
+| `name` | `str` | required | Agent display name; drives anchor path (`~/.unitares/anchors/<name_lower>.json`). |
+| `mcp_url` | `str` | `http://127.0.0.1:8767/mcp/` | Governance MCP endpoint. |
+| `persistent` | `bool` | `False` | Stamp the `persistent` + `autonomous` tags on fresh onboard. Set `True` for long-running residents. |
+| `refuse_fresh_onboard` | `bool` | `False` | Require `UNITARES_FIRST_RUN=1` to mint a new identity. Set `True` to prevent silent ghost-forks. |
+| `cycle_timeout_seconds` | `float \| None` | `None` | Hard cap on a single `run_once` / `run_forever` iteration. MCP's anyio task group can hang on `session.initialize` if the server flakes — use 60–120s. |
+| `log_file` | `Path \| None` | `None` | Log file to auto-trim after each cycle (in both `run_once` and `run_forever`, in a `finally` block so it fires on error and timeout too). Leave unset if launchd / logrotate owns rotation. |
+| `max_log_lines` | `int` | `10_000` | Trim threshold for `log_file`. |
+| `state_dir` | `Path \| None` | `<repo>/data/<name_lower>` | Default directory for state persistence. Used when `state_file` is not set. |
+| `state_file` | `Path \| None` | `None` | Explicit cross-cycle state path. Takes precedence over `state_dir / "state.json"` when set. |
+| `parent_agent_id` | `str \| None` | `None` | Forked-from UUID. Forwards to server on fresh onboard. |
+| `spawn_reason` | `str \| None` | `None` | Registered values: `subagent`, `dialectic_reviewer`, `dispatch`, `compaction`, `explicit`, `new_session`. Unknown values are accepted but receive no live-parent exemption. |
+
+## Lifecycle shapes
+
+- **Daemon:** `asyncio.run(agent.run_forever(interval=60))` — loops
+  forever with heartbeats when idle. Reference:
+  `agents/sentinel/agent.py`.
+- **Scheduled:** `asyncio.run(agent.run_once())` under launchd /
+  systemd cron. References: `agents/chronicler/agent.py`,
+  `agents/vigil/agent.py`.
+
+Both shapes respect `cycle_timeout_seconds` and auto-trim `log_file`.
+
+## State persistence
+
+- `self.save_state(d: dict)` and `self.load_state() -> dict` let your
+  `run_cycle` carry data across iterations. Writes are atomic
+  (`os.replace`).
+- Non-JSON-serializable values (e.g. `datetime`, `Path`) are coerced
+  to their `str()` representation on save rather than raising
+  `TypeError`. You get a lossy round-trip, not a silent state-write
+  failure.
+
+## Identity rules
+
+1. The agent's first MCP call (`onboard` or `identity`) is the sole
+   source of identity. Do not set identity out-of-band.
+2. UUID is the ground truth. `client_session_id` and
+   `continuity_token` are cache keys for ephemeral clients; residents
+   don't need them.
+3. Anchors live at `~/.unitares/anchors/<name_lower>.json`. One
+   anchor per host per role. The file contains `agent_uuid` and is
+   written atomically.
+4. Never silent-swap an identity. If the anchor is missing and
+   `refuse_fresh_onboard=True`, `_ensure_identity` raises
+   `IdentityBootstrapRefused` — the operator must explicitly set
+   `UNITARES_FIRST_RUN=1` once to mint a new one.
+
+## Not in the SDK (on purpose)
+
+- `agents/common/findings.py` and `agents/common/config.py` are
+  internal to the reference residents in this repo. If you need
+  findings-posting in your own resident, vendor the helper or POST to
+  `/api/findings` yourself — the REST contract is the public surface.
+- The violation taxonomy is server-owned vocabulary
+  (`src/violation_taxonomy.yaml`); consume it via the `/v1/taxonomy`
+  endpoint rather than importing server code.
+- Watcher (`agents/watcher/agent.py`) uses a different execution
+  model (sync, hook-driven, one-shot per tool-use event) and does not
+  subclass `GovernanceAgent`.

unitares_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+# >=77 for PEP 639 (SPDX `license` string + `license-files`).
+requires = ["setuptools>=77.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "unitares-sdk"
+version = "0.1.0"
+description = "Agent SDK for UNITARES governance — check-in loop, EISV state, identity anchors, and lease-plane client for long-lived AI agents"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "cirwel" }]
+keywords = ["ai-agents", "governance", "mcp", "multi-agent-systems", "observability"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: System :: Monitoring",
+]
+requires-python = ">=3.12"
+dependencies = [
+    "httpx>=0.27.0,<1.0.0",
+    "mcp>=1.26.0,<2.0.0",
+    "pydantic>=2.0.0,<3.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.4.0,<10.0.0",
+    "pytest-asyncio>=0.21.0,<2.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/cirwel/unitares"
+Documentation = "https://github.com/cirwel/unitares/blob/master/agents/sdk/README.md"
+Source = "https://github.com/cirwel/unitares"
+Issues = "https://github.com/cirwel/unitares/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+unitares_sdk = ["py.typed"]

unitares_sdk-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+