agent-status 0.1.4__tar.gz

agent_status-0.1.4/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 astatus contributors
+
+   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.

agent_status-0.1.4/PKG-INFO

@@ -0,0 +1,297 @@
+Metadata-Version: 2.4
+Name: agent-status
+Version: 0.1.4
+Summary: Local agent status reference implementation
+Author: astatus contributors
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/julsemaan/astatus
+Project-URL: Repository, https://github.com/julsemaan/astatus
+Project-URL: Issues, https://github.com/julsemaan/astatus/issues
+Keywords: agent,status,local,a2a,cli
+Classifier: Development Status :: 3 - Alpha
+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
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rich>=13
+Dynamic: license-file
+
+# agent-status
+
+`agent-status` is a generic local agent status standard with a small reference CLI. Core file format and validation logic stay lean. Display commands `list` and `watch` require `rich`; non-display commands like `emit`, `get`, `validate`, and `prune` work without it.
+
+## Why a local status layer exists
+
+Remote protocols answer remote questions. Local operators still need fast answers to a different set of questions: which agents are running here, what are they doing, and is the latest snapshot stale?
+
+Why this needs its own standard:
+- A2A is designed for remote discovery and task interaction, not workstation-local runtime visibility.
+- Local operators need data that A2A does not model directly, such as process lifecycle, PID, workspace, and heartbeat freshness.
+- One file per agent instance enables simple tooling: shell scripts, CLIs, watchers, and validators can all read the same shape.
+- Shared writer and reader rules prevent ad hoc status files from drifting on filenames, fields, stale semantics, and shutdown behavior.
+- `${XDG_STATE_HOME:-~/.local/state}` is a good fit for persistent user state that is local to a machine.
+
+## Relation to A2A
+
+This project is an A2A-compatible local status layer. It complements A2A rather than replacing it. It does not replace Agent Card discovery, Task APIs, or full A2A service behavior.
+
+A2A answers, "How do agents talk to each other?" This repository answers, "What is running on this machine right now?"
+
+See:
+- `docs/agent-status-v1alpha1.md`
+- `docs/a2a-compat.md`
+
+## Install
+
+Python 3.10+.
+
+From PyPI:
+
+```bash
+pip install agent-status
+```
+
+Manual setup:
+
+```bash
+python3 -m venv .venv
+. .venv/bin/activate
+pip install -e .
+```
+
+Devbox alternative:
+
+```bash
+devbox shell
+python -m pip install -e .
+```
+
+Devbox uses same `.venv` path via `VENV_DIR=.venv`.
+
+### Pi extension install
+
+Pi package lives in `pi-extension/`, exported from repo root `package.json` like `ponytail`.
+
+Install from local checkout:
+
+```bash
+pi install /path/to/astatus
+```
+
+Do not install `./pi-extension` directly. Repo root `package.json` exports extension.
+After install in running pi session, run `/reload` or restart pi so `session_start` fires for new extension.
+
+Install from git:
+
+```bash
+pi install git:github.com/you/astatus
+```
+
+One-shot test without install:
+
+```bash
+pi -e ./pi-extension/index.js
+```
+
+## Build
+
+Build a wheel and source distribution:
+
+```bash
+python -m pip install build
+python -m build
+```
+
+Install from built wheel in a fresh environment:
+
+```bash
+python -m venv /tmp/astatus-smoke
+. /tmp/astatus-smoke/bin/activate
+pip install dist/*.whl
+agent-status --help
+```
+
+## Quick start
+
+Emit one snapshot:
+
+```bash
+RUN_ID="pi-$(python3 - <<'PY'
+import uuid
+print(uuid.uuid4().hex)
+PY
+)"
+
+python3 -m agent_status emit \
+  --agent-id "$RUN_ID" \
+  --agent-name pi \
+  --lifecycle running \
+  --workspace "$PWD" \
+  --pid $$ \
+  --task-id task-123 \
+  --task-state working \
+  --task-summary "refactor scheduler tests" \
+  --task-status-timestamp 2026-06-20T16:44:55Z
+```
+
+`agent_id` must be unique per running agent instance. Do not derive it from PID alone: sandboxed sessions can share same PID and collide. `runtime.pid` is descriptive metadata only.
+
+List snapshots:
+
+```bash
+python3 -m agent_status list
+```
+
+Get one snapshot:
+
+```bash
+python3 -m agent_status get "$RUN_ID"
+```
+
+Watch snapshots:
+
+```bash
+python3 -m agent_status watch --interval 2
+```
+
+Prune old stale or stopped snapshots:
+
+```bash
+python3 -m agent_status prune --prune-after 86400
+```
+
+Validate a file:
+
+```bash
+python3 -m agent_status validate examples/sample-status.json
+```
+
+## Protocol summary
+
+Default status directory:
+
+```text
+${AGENT_STATUS_DIR:-${XDG_STATE_HOME:-~/.local/state}/agent-status}
+```
+
+One running agent instance maps to one file:
+
+```text
+<agent_id>.json
+```
+
+Core required fields:
+- `schema_version`
+- `agent_id`
+- `agent_name`
+- `runtime.lifecycle`
+- `runtime.updated_at`
+
+Task state uses A2A-style values. `idle`, `stale`, and `missing` are derived by readers and are never written directly.
+
+## JSON example
+
+```json
+{
+  "schema_version": "agent-status/v1alpha1",
+  "agent_id": "pi-7d5d6ca5e54c44cfb9e8d5acfd3c71a1",
+  "agent_name": "pi",
+  "runtime": {
+    "lifecycle": "running",
+    "updated_at": "2026-06-20T16:45:00Z",
+    "last_activity_at": "2026-06-20T16:44:52Z",
+    "pid": 12345,
+    "workspace": "/home/julien/src/project"
+  },
+  "task": {
+    "id": "task-123",
+    "context_id": "ctx-456",
+    "state": "working",
+    "summary": "refactor scheduler tests",
+    "status_timestamp": "2026-06-20T16:44:55Z"
+  }
+}
+```
+
+## CLI examples
+
+After installation, you can also use the entry point directly:
+
+```bash
+agent-status emit --agent-id "pi-$(python3 - <<'PY'
+import uuid
+print(uuid.uuid4().hex)
+PY
+)" --agent-name pi --lifecycle running
+agent-status list
+agent-status get <agent-id>
+agent-status watch
+agent-status prune --prune-after 86400
+agent-status validate examples/sample-status.json
+```
+
+## Writer rules
+
+- Write the whole file atomically.
+- `agent_id` must be unique per running instance. PID-only IDs like `pi-12345` are unsafe under PID namespaces or sandboxes.
+- Use an absolute workspace path when it is known.
+- Update on lifecycle changes, task changes, summary changes, and heartbeats.
+- Send a heartbeat every 15 to 30 seconds.
+- On clean exit, either remove the file or persist `runtime.lifecycle=stopped`.
+- If you use temp files for atomic writes, temp names need random or OS-guaranteed uniqueness. Do not rely on PID suffixes.
+
+## Stale semantics
+
+The default `stale_after` value is 60 seconds.
+
+A reader marks a record as stale when:
+
+```text
+now - runtime.updated_at > stale_after
+```
+
+If `runtime.lifecycle=running` and there is no `task`, a reader may render the agent as `idle`.
+
+A stale file is not definitive proof that the writer is gone permanently. The agent may be crashed, suspended, disconnected, or simply slow. Readers should mark records as stale rather than deleting them silently. Cleanup is a separate operator policy.
+
+The reference CLI provides explicit cleanup:
+
+```bash
+agent-status prune --prune-after 86400
+```
+
+The default prune policy removes snapshots older than 24 hours if they are already stale, along with older snapshots whose `runtime.lifecycle` is `stopped`.
+
+## Validation
+
+Run tests:
+
+```bash
+python3 -m unittest
+```
+
+Validate examples:
+
+```bash
+python3 -m agent_status validate examples/sample-status.json
+python3 -m agent_status validate examples/a2a-linked-status.json
+```
+
+## Roadmap
+
+Possible future additions:
+- HTTP exporter
+- registry bridge
+- richer TUI or shell integrations
+
+Out of scope for now:
+- registry server
+- full A2A server
+- orchestration layer
+- history store