chatpanel 0.1.0__tar.gz

chatpanel-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.

chatpanel-0.1.0/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: chatpanel
+Version: 0.1.0
+Summary: Typed client for the local ChatPanel gateway — chat through the privacy proxy, search the user's history, read and write memory, follow team runs. Zero dependencies.
+License: Apache-2.0
+Project-URL: Homepage, https://chatpanel.net
+Project-URL: Repository, https://github.com/chatpanel/chatpanel-sdk
+Keywords: chatpanel,sdk,client,gateway,privacy,llm,agents
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# chatpanel
+
+A typed client for the local [ChatPanel](https://chatpanel.net) gateway. Zero dependencies;
+Python 3.11+; streaming; pairing.
+
+```
+pip install chatpanel
+```
+
+```python
+from chatpanel import ChatPanel
+
+cp = ChatPanel.from_environment()      # token from ~/.chatpanel/gateway-token
+
+# Ask a model — through the gateway, so names/emails/numbers are redacted on the way out
+for text in cp.chat.text({"model": "claude", "messages": [{"role": "user", "content": "Summarise our rollback decision."}]}):
+    print(text, end="", flush=True)
+
+# Search the user's history (chats, notes, meetings, briefs)
+hits = cp.history.smart_search({"question": "what did we decide about the rollback?", "queries": ["rollback decision"]})
+record = cp.history.get({"id": hits["results"][0]["id"], "maxChars": 4000})
+
+# Memory
+recalled = cp.memory.recall({"text": "how does the user like answers written"})
+cp.memory.remember({"text": "Prefers short answers with a code sample", "source": {"via": "my-app"}})  # needs the token
+
+# What the model would receive
+preview = cp.redaction.preview({"text": "Call Jordan at 555-0100"})   # "Call [[PERSON_1]] at [[PHONE_1]]"
+
+# Follow a team run live
+for frame in cp.teams.run_events(run_id, {"after": -1}):
+    print(frame.data["type"])
+```
+
+Pairing from an application that cannot read the token file: `cp.pair(code)` exchanges a
+code from `chatpanel-gateway pair` and returns the token for you to keep (keychain or a
+0600 file — never a log).
+
+Every failure is a `ChatPanelError` with `status`, `type` and `operation`:
+`GatewayUnreachableError`, `GatewayTooOldError` (`have`, `need`), `ForbiddenError`,
+`NotFoundError`, `InvalidRequestError`.
+
+```python
+ChatPanel(
+    base_url="http://127.0.0.1:4320",   # loopback only, unless allow_remote=True + https
+    token=lambda: keyring.get_password("chatpanel", "gateway"),
+    timeout=20.0, retries=2, version_gate=True,
+)
+```
+
+The surface (`cp.history`, `cp.memory`, …) is generated from the gateway's OpenAPI contract in
+the [chatpanel-sdk](https://github.com/chatpanel/chatpanel-sdk) repository; `cp.request(op_id, ...)`
+reaches any operation by id. The client is synchronous; wrap calls in `asyncio.to_thread` from
+async code.

chatpanel-0.1.0/README.md

@@ -0,0 +1,54 @@
+# chatpanel
+
+A typed client for the local [ChatPanel](https://chatpanel.net) gateway. Zero dependencies;
+Python 3.11+; streaming; pairing.
+
+```
+pip install chatpanel
+```
+
+```python
+from chatpanel import ChatPanel
+
+cp = ChatPanel.from_environment()      # token from ~/.chatpanel/gateway-token
+
+# Ask a model — through the gateway, so names/emails/numbers are redacted on the way out
+for text in cp.chat.text({"model": "claude", "messages": [{"role": "user", "content": "Summarise our rollback decision."}]}):
+    print(text, end="", flush=True)
+
+# Search the user's history (chats, notes, meetings, briefs)
+hits = cp.history.smart_search({"question": "what did we decide about the rollback?", "queries": ["rollback decision"]})
+record = cp.history.get({"id": hits["results"][0]["id"], "maxChars": 4000})
+
+# Memory
+recalled = cp.memory.recall({"text": "how does the user like answers written"})
+cp.memory.remember({"text": "Prefers short answers with a code sample", "source": {"via": "my-app"}})  # needs the token
+
+# What the model would receive
+preview = cp.redaction.preview({"text": "Call Jordan at 555-0100"})   # "Call [[PERSON_1]] at [[PHONE_1]]"
+
+# Follow a team run live
+for frame in cp.teams.run_events(run_id, {"after": -1}):
+    print(frame.data["type"])
+```
+
+Pairing from an application that cannot read the token file: `cp.pair(code)` exchanges a
+code from `chatpanel-gateway pair` and returns the token for you to keep (keychain or a
+0600 file — never a log).
+
+Every failure is a `ChatPanelError` with `status`, `type` and `operation`:
+`GatewayUnreachableError`, `GatewayTooOldError` (`have`, `need`), `ForbiddenError`,
+`NotFoundError`, `InvalidRequestError`.
+
+```python
+ChatPanel(
+    base_url="http://127.0.0.1:4320",   # loopback only, unless allow_remote=True + https
+    token=lambda: keyring.get_password("chatpanel", "gateway"),
+    timeout=20.0, retries=2, version_gate=True,
+)
+```
+
+The surface (`cp.history`, `cp.memory`, …) is generated from the gateway's OpenAPI contract in
+the [chatpanel-sdk](https://github.com/chatpanel/chatpanel-sdk) repository; `cp.request(op_id, ...)`
+reaches any operation by id. The client is synchronous; wrap calls in `asyncio.to_thread` from
+async code.

chatpanel-0.1.0/chatpanel/__init__.py

@@ -0,0 +1,135 @@
+"""chatpanel — a typed client for the local ChatPanel gateway.
+
+    from chatpanel import ChatPanel
+    cp = ChatPanel.from_environment()             # reads ~/.chatpanel/gateway-token
+    hits = cp.history.smart_search({"question": "what did we decide about the launch?"})
+    for text in cp.chat.text({"model": "claude", "messages": [{"role": "user", "content": "hi"}]}):
+        print(text, end="", flush=True)
+
+The namespaces (``history``, ``memory``, ``chat``, …) are GENERATED from the contract; this
+module adds the few things that need judgement: construction, discovery, pairing, and a text
+iterator over the chat stream.
+"""
+
+from __future__ import annotations
+
+from typing import Any, Dict, Iterator, Optional
+
+from . import _types_generated as types
+from ._api_generated import OPERATIONS, Api
+from ._runtime import (
+    DEFAULT_BASE_URL,
+    TOKEN_ENV,
+    TOKEN_PATH_ENV,
+    URL_ENV,
+    Operation,
+    Runtime,
+    SseFrame,
+    TokenSource,
+    compare_versions,
+    discover_base_url,
+    discover_token,
+    normalise_base_url,
+    parse_frame,
+)
+from .errors import (
+    ChatPanelError,
+    ForbiddenError,
+    GatewayTooOldError,
+    GatewayUnreachableError,
+    InvalidRequestError,
+    NotFoundError,
+)
+
+__all__ = [
+    "ChatPanel", "Runtime", "Operation", "OPERATIONS", "SseFrame", "types",
+    "ChatPanelError", "ForbiddenError", "GatewayTooOldError", "GatewayUnreachableError", "InvalidRequestError", "NotFoundError",
+    "compare_versions", "normalise_base_url", "parse_frame", "delta_text",
+    "discover_base_url", "discover_token", "DEFAULT_BASE_URL", "TOKEN_ENV", "TOKEN_PATH_ENV", "URL_ENV",
+]
+
+__version__ = "0.1.0"
+
+
+def delta_text(frame: SseFrame[Any]) -> str:
+    """The text of one streamed chunk, or '' when the frame carried none (usage, a tool call)."""
+    d = frame.data
+    if not isinstance(d, dict):
+        return ""
+    choices = d.get("choices") or []
+    delta = choices[0].get("delta") if choices and isinstance(choices[0], dict) else None
+    content = delta.get("content") if isinstance(delta, dict) else None
+    return content if isinstance(content, str) else ""
+
+
+class _Chat:
+    """The generated chat namespace plus ``text()``."""
+
+    def __init__(self, inner: Any) -> None:
+        self._inner = inner
+
+    def __getattr__(self, name: str) -> Any:
+        return getattr(self._inner, name)
+
+    def text(self, body: Dict[str, Any], *, headers: Optional[Dict[str, str]] = None, timeout: Optional[float] = None) -> Iterator[str]:
+        """Stream just the text of a reply. Tool calls and usage frames are skipped; use ``completions_stream`` for those."""
+        for frame in self._inner.completions_stream(body, headers=headers, timeout=timeout):
+            t = delta_text(frame)
+            if t:
+                yield t
+
+
+class ChatPanel:
+    def __init__(
+        self,
+        base_url: Optional[str] = None,
+        token: TokenSource = None,
+        *,
+        allow_remote: bool = False,
+        timeout: float = 20.0,
+        retries: int = 2,
+        version_gate: bool = True,
+        user_agent: str = "",
+        opener: Any = None,
+    ) -> None:
+        self.runtime = Runtime(base_url, token, allow_remote=allow_remote, timeout=timeout, retries=retries, version_gate=version_gate, user_agent=user_agent, opener=opener)
+        api = Api(self.runtime)
+        self.gateway = api.gateway
+        self.models = api.models
+        self.chat = _Chat(api.chat)
+        self.redaction = api.redaction
+        self.history = api.history
+        self.memory = api.memory
+        self.prefs = api.prefs
+        self.teams = api.teams
+        self.projects = api.projects
+        self.agents = api.agents
+        self.engines = api.engines
+        self.skills = api.skills
+
+    def __repr__(self) -> str:
+        return f"ChatPanel({self.runtime.base_url})"
+
+    @classmethod
+    def from_environment(cls, **kwargs: Any) -> "ChatPanel":
+        """A client for the gateway on this machine, authenticated as the current user: the URL from
+        ``CHATPANEL_GATEWAY_URL`` and the token from ``CHATPANEL_GATEWAY_TOKEN`` or the token file."""
+        kwargs.setdefault("base_url", discover_base_url())
+        return cls(token=discover_token() or None, **kwargs)
+
+    def health(self) -> "types.Health":
+        return self.gateway.health()
+
+    def whoami(self) -> "types.WhoAmI":
+        return self.gateway.whoami()
+
+    def pair(self, code: str) -> "types.Paired":
+        """Exchange a one-time code for the token and start using it. The token is RETURNED so the
+        application can persist it — in the platform keychain or a 0600 file, never in a log."""
+        paired = self.gateway.pair({"code": str(code).strip()})
+        self.runtime.set_token(paired["token"])
+        return paired
+
+    def request(self, operation_id: str, **kwargs: Any) -> Any:
+        """Any operation by id — for a route added to the contract before this package learnt a method for it."""
+        return self.runtime.request(OPERATIONS[operation_id], **kwargs)