agent-control-panel 0.1.0__tar.gz

agent_control_panel-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+__pycache__/
+*.py[cod]
+.venv*/
+dist/
+build/
+*.egg-info/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/

agent_control_panel-0.1.0/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+All notable changes to the Python SDK. Versions stay `0.x` until the wire contract is proven with real
+customers; after the first public release, contract changes are additive only (clients live inside customer
+apps). The wire contract is the same as the Node SDK (`agent-control-panel` on npm).
+
+## 0.1.0 (2026-09-29)
+
+First release, with the same behaviour and wire contract as the Node SDK 0.3.0:
+
+- `create_client(...)` with the same validation: `https` only (plain `http` for loopback hosts, or with
+  `allow_insecure_http=True` for local development), credentials trimmed, refuses to start without a
+  webhook secret, `ACP_DISABLE_CONTROL=1` honoured.
+- Fail-open reporting: `report_run` buffers and never raises; batched flushes with retry and jitter; the
+  oldest runs are dropped past `max_buffer`. Heartbeats and flushes run on daemon threads; pending runs are
+  flushed on interpreter exit.
+- `wrap_agent_run` / `wrap_agent_run_async`: refuse to run while paused or stopped (`AgentPausedError`),
+  report tokens and the answer text (`extract_text`: OpenAI Chat and Responses, Anthropic, Gemini, `text`;
+  reads keys and attributes only, never calls methods), accept `user_input` and `full_input`, and re-raise
+  your exception unchanged.
+- Run content: full fields are sent as JSON text cut to 100,000 characters (counted in UTF-16 units, as ACP
+  does) and flagged `full_input_truncated` / `full_output_truncated`; large flushes are split into requests
+  under 4 MB. `capture_content=False` sends metadata only, from `wrap_agent_run` and `report_run` alike.
+- Remote control: `handle_webhook` / `webhook_response` verify signature v2 (timestamp + nonce, 300 s skew,
+  single-use nonces, previous secret during rotation) and apply pause, resume, stop, restart,
+  `update_model` and `update_prompt`. Durable pause and model swaps through the heartbeat reply, with the
+  same rules: a hold set locally is never released by ACP, and replies older than the last applied command
+  are ignored.
+- `fetch_prompt()` with a 60 s cache and fallback to the last prompt.
+- Zero runtime dependencies; typed (`py.typed`); Python 3.10+.
+- Redirects are never followed (the API key is never sent to another host); a 3xx is logged with its target
+  so you know which URL to update.

agent_control_panel-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

agent_control_panel-0.1.0/PKG-INFO

@@ -0,0 +1,245 @@
+Metadata-Version: 2.5
+Name: agent-control-panel
+Version: 0.1.0
+Summary: Agent Control Panel SDK for Python: fail-open reporting and remote control for AI agents
+Project-URL: Homepage, https://github.com/Saadtamari/agent-control-panel-python#readme
+Project-URL: Source, https://github.com/Saadtamari/agent-control-panel-python
+Project-URL: Issues, https://github.com/Saadtamari/agent-control-panel-python/issues
+Project-URL: Changelog, https://github.com/Saadtamari/agent-control-panel-python/blob/main/CHANGELOG.md
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agents,ai,anthropic,control-plane,llm,observability,openai
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# Agent Control Panel SDK for Python
+
+Connect an AI agent that already runs in your app to [Agent Control Panel](https://acp.skaigroup.tech)
+(ACP): report every run (tokens, model, latency, errors, the answer) and let your team **pause, resume, stop,
+restart, swap the model or push an approved prompt** without redeploying.
+
+- **Fail-open.** If ACP is slow or down, your agent keeps working. Reporting is buffered and retried on a
+  background thread; nothing the SDK does raises into your code (except `AgentPausedError`, on purpose).
+- **Signed control.** Commands are HMAC-SHA256 signed with a timestamp and a single-use nonce; unsigned,
+  replayed, stale or wrong-agent commands are rejected.
+- **Durable pause and model swaps.** A pause or a model swap set in ACP survives restarts, extra workers and
+  missed webhooks: every heartbeat reply carries the state ACP holds, and the client adopts it.
+- **Zero runtime dependencies.** Python 3.10+, standard library only, fully typed (`py.typed`).
+
+Same behaviour and wire contract as the Node SDK (`agent-control-panel` on npm); both are tested against
+the same contract vectors.
+
+```bash
+pip install agent-control-panel
+```
+
+## Quickstart
+
+```python
+import os
+from agent_control_panel import AgentPausedError, create_client
+
+acp = create_client(
+    url=os.environ["ACP_URL"],                      # your control panel URL
+    api_key=os.environ["ACP_API_KEY"],              # shown once when the key is created
+    agent_id=os.environ["ACP_AGENT_ID"],            # from the app page in ACP
+    webhook_secret=os.environ["ACP_WEBHOOK_SECRET"],
+)
+acp.start()  # heartbeats every 30 s, flushes every 5 s, on daemon threads
+
+def handle(question: str) -> str:
+    try:
+        return acp.wrap_agent_run(
+            lambda: my_agent(question, system_prompt=acp.fetch_prompt() or DEFAULT_PROMPT),
+            user_input=question,
+            model_used=acp.get_effective_model("gpt-4o-mini"),
+        )
+    except AgentPausedError:
+        return "This assistant is paused. Please try again later."
+```
+
+`wrap_agent_run` records duration, success or error, token usage and the answer text, read from the
+response objects of the OpenAI, Anthropic and Google Gemini SDKs (and plain dicts of the same shape). For
+anything else, return a string or call `report_run(...)` yourself. While the agent is paused or stopped it
+raises `AgentPausedError` **without calling your function**, so a pause really stops model calls.
+
+ACP's quality reviews, Test Lab and error explanations read the user input, the full input and the output,
+so pass `user_input` and `full_input` for accurate results (each field is kept up to 100,000 characters). To
+send metadata only, create the client with `capture_content=False`.
+
+### OpenAI
+
+```python
+from openai import OpenAI
+
+openai = OpenAI()
+
+def answer(question: str) -> str:
+    model = acp.get_effective_model("gpt-4o-mini")
+    messages = [
+        {"role": "system", "content": acp.fetch_prompt() or "You are a helpful assistant."},
+        {"role": "user", "content": question},
+    ]
+    completion = acp.wrap_agent_run(
+        lambda: openai.chat.completions.create(model=model, messages=messages),
+        user_input=question,
+        full_input=messages,
+        model_used=model,
+    )
+    return completion.choices[0].message.content or ""
+```
+
+### Anthropic (async)
+
+```python
+import asyncio
+from anthropic import AsyncAnthropic
+
+claude = AsyncAnthropic()
+
+async def answer(question: str) -> str:
+    model = acp.get_effective_model("claude-sonnet-4-5")
+    system = await asyncio.to_thread(acp.fetch_prompt)  # fetch_prompt blocks up to 5 s
+    messages = [{"role": "user", "content": question}]
+    message = await acp.wrap_agent_run_async(
+        lambda: claude.messages.create(model=model, max_tokens=1024, system=system, messages=messages),
+        user_input=question,
+        full_input=messages,
+        model_used=model,
+    )
+    return "".join(block.text for block in message.content if block.type == "text")
+```
+
+Anthropic prompt-cache tokens are counted as input tokens.
+
+## Receive control commands
+
+ACP sends signed commands to `<Deployed URL>/api/acp/webhook` (set the Deployed URL on the app page).
+Pass the **raw request body** (bytes), not re-serialised JSON: the signature covers the exact bytes.
+`webhook_response` returns the HTTP status (200 applied, 409 for another agent's command, 401 otherwise) and
+a JSON body.
+
+**FastAPI**
+
+```python
+from fastapi import FastAPI, Request
+from fastapi.responses import JSONResponse
+
+app = FastAPI()
+
+@app.post("/api/acp/webhook")
+async def acp_webhook(request: Request) -> JSONResponse:
+    status, body = acp.webhook_response(request.headers, await request.body())
+    return JSONResponse(body, status_code=status)
+```
+
+**Flask**
+
+```python
+from flask import Flask, jsonify, request
+
+app = Flask(__name__)
+
+@app.post("/api/acp/webhook")
+def acp_webhook():
+    status, body = acp.webhook_response(request.headers, request.get_data())
+    return jsonify(body), status
+```
+
+**Django**
+
+```python
+from django.http import JsonResponse
+from django.views.decorators.csrf import csrf_exempt
+from django.views.decorators.http import require_POST
+
+@csrf_exempt  # ACP requests are authenticated by their HMAC signature, not a CSRF token
+@require_POST
+def acp_webhook(request):
+    status, body = acp.webhook_response(request.headers, request.body)
+    return JsonResponse(body, status=status)
+```
+
+No public URL (local development, a worker, a cron job)? Control still works: pause, stop, resume and model
+swaps arrive with the next heartbeat (within 30 s), and prompt changes are fetched before each run.
+
+## API
+
+| Member | What it does |
+|---|---|
+| `create_client(...)` | `url`, `api_key`, `agent_id`, `webhook_secret` (required); `webhook_secret_prev` during rotation; `heartbeat_seconds` (30), `flush_seconds` (5), `flush_at` (50), `max_buffer` (200); `logger`; `disable_control`; `capture_content` (default `True`; `False` = metadata only); `allow_insecure_http` (development only); `transport` (for tests). `url` must be https (or http to localhost). Raises `ValueError` for a missing credential or an insecure URL. |
+| `start()` / `stop(timeout=10)` | Start heartbeats and background flushing / flush everything and stop, giving up after `timeout`. The threads never keep your process alive; pending runs are flushed at interpreter exit. `with create_client(...) as acp:` does both. |
+| `wrap_agent_run(fn, *, user_input, full_input, input_summary, model_used)` | Run `fn()`, report it (with the answer text from the result), re-raise its exception unchanged. Raises `AgentPausedError` while paused or stopped. |
+| `wrap_agent_run_async(fn, ...)` | The same for coroutines: `await acp.wrap_agent_run_async(lambda: client.create(...))`. |
+| `report_run(status, **fields)` | Report a run yourself (tokens, model, timings, summaries, `user_input`, `full_input`, `full_output`, `error_message`, `trigger`, optional `dedupe_key`). Buffered; never raises. |
+| `extract_text(result)` / `extract_tokens(result)` | The answer text / token counts of an OpenAI, Anthropic or Gemini response, or `None`. |
+| `fetch_prompt()` | The agent's current prompt from ACP (composed with its skills), cached 60 s; falls back to the last prompt on any error. |
+| `get_effective_model(fallback)` | The model ACP asked for (after a model swap), else `fallback`. |
+| `status` | `idle`, `running`, `paused` or `stopped`. |
+| `handle_webhook(headers, raw_body)` / `webhook_response(...)` | Verify and apply a signed command / the same as an HTTP status and JSON body. |
+| `apply_command(command, payload=None)` | Apply a command locally (e.g. your own kill switch). A pause set this way is never lifted by ACP. |
+
+## Security
+
+- Never commit `ACP_API_KEY` or `ACP_WEBHOOK_SECRET`; keep them in your platform's secrets.
+- `ACP_DISABLE_CONTROL=1` (or `disable_control=True`) ignores every control command while reporting keeps
+  working: a local kill switch that does not depend on ACP.
+- Rotate the webhook secret in ACP, then set the old one as `webhook_secret_prev` until every instance has
+  the new one.
+- Commands are accepted only within 5 minutes of their timestamp and only once (nonce cache, safe across
+  threads).
+- Run content (user input, full input, the answer) is sent to ACP by default, cut to 100,000 characters per
+  field. Leave out anything you must not share, or use `capture_content=False` for metadata only.
+- Redirects are never followed: requests carry the API key, so a redirect is logged with where ACP moved
+  ("ACP moved to ...; update your url") and the request fails open.
+- TLS certificates are verified with the system's default trust store.
+
+## Troubleshooting
+
+| Log line | Meaning | Fix |
+|---|---|---|
+| `-> 401: ACP rejected the API key` | The key is wrong, revoked or expired. | Rotate the key on the app page, copy the full key from the dialog, set `ACP_API_KEY`. |
+| `ACP moved to https://...; update your url` | ACP answered with a redirect. | Set `ACP_URL` to the address in the message. |
+| `reason: bad_signature` in the webhook answer | `ACP_WEBHOOK_SECRET` differs from the app's secret in ACP, or the body was re-serialised before verification. | Reveal the secret on the app page and set it again; pass the raw body. |
+| `control rejected: command for agent ... reached agent ...` | Several agents share one webhook URL but this client is configured for another agent. | One client (and `agent_id`) per agent. |
+| `CERTIFICATE_VERIFY_FAILED` | Python cannot find root certificates (common with python.org installers on macOS). | Run "Install Certificates.command" from the Python folder, or install your OS's CA bundle. |
+
+Warnings are logged to the `agent_control_panel` logger and reach stderr unless you configure logging.
+
+**Forking servers (gunicorn with `--preload`, multiprocessing).** Threads do not survive `fork()`. The SDK
+resets itself in the child and restarts its threads on the next report, and runs buffered before the fork
+stay with the parent. Creating the client in each worker (e.g. gunicorn's `post_fork` hook) is simplest.
+
+**Serverless and short scripts.** Call `acp.stop()` (or use `with create_client(...) as acp:`) before the
+function returns so buffered runs are sent; frozen containers do not run exit hooks.
+
+## Development
+
+```bash
+python -m venv .venv && . .venv/bin/activate
+pip install --require-hashes -r requirements-dev.txt
+ruff check src tests && ruff format --check src tests && mypy && pytest
+python -m build
+```
+
+The SDK is developed in the Agent Control Panel repository, next to the server it talks to, so contract
+changes are tested on both sides together (`tests/contract/vectors.json` is generated there). This public
+repository receives one commit per release. Issues and pull requests are welcome here; accepted changes are
+applied upstream and ship in the next release.
+
+## License
+
+[Apache License 2.0](LICENSE). It includes an explicit patent grant from contributors, and ends that grant
+for anyone who sues over patents in the SDK.