pycodex-ws 0.3.2__tar.gz → 0.4.0__tar.gz

pycodex_ws-0.4.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright 2025 OpenAI
+
+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.

pycodex_ws-0.4.0/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.1
+Name: pycodex-ws
+Version: 0.4.0
+Summary: Browser workspace, Feishu and IPython integrations for python-codex
+License-File: LICENSE
+Requires-Python: >=3.7
+Requires-Dist: ipython>=7
+Requires-Dist: lark-oapi
+Requires-Dist: pillow>=9.0.0
+Requires-Dist: python-codex==0.4.0
+Description-Content-Type: text/markdown
+
+# pycodex-ws
+
+`pycodex-ws` provides the browser workspace, Canvas and file/diff viewer,
+Feishu integration and IPython tools for
+[`python-codex`](https://pypi.org/project/python-codex/). It installs the exact
+matching core version and all integration dependencies.
+
+Pillow is a direct dependency of this package for image preview validation.
+Core can run without it; `view_image` then sends original image bytes.
+
+The HTTP and WebSocket server uses Starlette and Uvicorn, provided by core,
+without FastAPI, Pydantic or `pydantic-core`.
+
+```bash
+python3 -m pip install pycodex-ws
+pycodex-ws --help
+```
+
+Requires Python 3.7 or newer. With multiple Python installations, use the
+installing interpreter to launch either frontend directly:
+
+```bash
+python3 -m workspace_server --help
+python3 -m pycodex --help
+```
+
+This distribution owns `workspace_server`, `pycodex_ws`, the frontend assets,
+and the `pycodex-ws` console script. The core owns `pycodex`, `responses_server`,
+the `pycodex` command and portable storage.
+
+The [VS Code extension](extensions/vscode/README.md) lives in this package's
+source directory. It starts the workspace server and uses its HTTP API.
+It is built and distributed separately as a VSIX, outside both Python wheels
+and source distributions.
+
+In the browser's code and diff viewer, right-click **Insert into chat**, or
+select text and click the toolbar button, to insert context into the current
+conversation's draft. Context uses the full view label, including both revisions
+of a diff, and identifies the selected side. It includes either selected text and
+its range, or only the cursor position. Context appears as a separate block among the message
+text; click a block to edit or remove it before sending.
+
+Workspace sessions include `/link` and `/unlink` for Feishu. Python callers use
+`pycodex_ws.build_runtime(agent)` for the same assembly, or
+`from pycodex_ws.ipython import ipython_agent` inside an IPython session.
+
+For initial Feishu user authorization, run the module included in this package:
+
+```bash
+python3 -m pycodex_ws.feishu_oauth
+```
+
+It reads app credentials from `~/.codex/.env` and stores the refresh token in
+`~/.codex/.feishu_refresh_token` with mode `0600`. `--help` works without
+credentials. In a development checkout, use
+`uv run --dev python -m pycodex_ws.feishu_oauth`.
+
+Use a filename prefix and a separate Canvas switch in `workspaces.json`:
+
+```json
+{
+  "workspaces": [
+    {"id": "demo", "work_dir": ".", "state_path": "demo", "enable_board": true}
+  ]
+}
+```
+
+Start it with `pycodex-ws --workspace-config workspaces.json`.
+Relative paths resolve from the configuration directory. This example uses
+`demo.pycodex-ws.json` for session titles and rollout references,
+`demo.pycodex-views.json` for file views, and `demo.html` for Canvas.
+All suffixes are appended to the complete prefix, including any dots.
+The resolved `state_path` identifies the workspace; two entries cannot share it.
+Creating a workspace through the management page or API without a prefix
+generates a `/tmp/pcws-*` prefix and saves it in the configuration.
+
+`enable_board` defaults to `true`. Setting it to `false` disables the Canvas
+tab, HTML/image/status routes, polling and Canvas context injection. Sessions
+and file views still save and restore from the same prefix, so changing this
+switch preserves their state.
+
+Existing `board: "demo.html"` configurations load as `state_path: "demo"`.
+Existing `board: false` entries use `<config-stem>.<workspace-id>` as their
+prefix, preserving their session index. Loading leaves files in place; later
+configuration saves write only `state_path` and `enable_board`.
+Do not mix the old and new fields. For an old Canvas path with an extension
+other than `.html`, rename it to `<prefix>.html` and set `state_path` explicitly.
+Conversation contents remain in their original rollout files.
+Malformed session state stops restoration and leaves the saved file intact.
+
+Both packages are developed in the same repository. Run `uv sync --dev` at its
+root to install both, then `uv run pycodex-ws --help`. Build this package with
+`uv build packages/pycodex-ws`.
+
+Run `uv run --dev pytest packages/pycodex-ws/tests` from the repository root for
+workspace, Feishu, IPython and cross-frontend integration tests. Core tests live
+in the root `tests/` directory and use the independent `test` dependency group.
+`uv run --dev pytest` runs both suites; see [test documentation](../../tests/TESTS.md).

pycodex_ws-0.4.0/README.md

@@ -0,0 +1,98 @@
+# pycodex-ws
+
+`pycodex-ws` provides the browser workspace, Canvas and file/diff viewer,
+Feishu integration and IPython tools for
+[`python-codex`](https://pypi.org/project/python-codex/). It installs the exact
+matching core version and all integration dependencies.
+
+Pillow is a direct dependency of this package for image preview validation.
+Core can run without it; `view_image` then sends original image bytes.
+
+The HTTP and WebSocket server uses Starlette and Uvicorn, provided by core,
+without FastAPI, Pydantic or `pydantic-core`.
+
+```bash
+python3 -m pip install pycodex-ws
+pycodex-ws --help
+```
+
+Requires Python 3.7 or newer. With multiple Python installations, use the
+installing interpreter to launch either frontend directly:
+
+```bash
+python3 -m workspace_server --help
+python3 -m pycodex --help
+```
+
+This distribution owns `workspace_server`, `pycodex_ws`, the frontend assets,
+and the `pycodex-ws` console script. The core owns `pycodex`, `responses_server`,
+the `pycodex` command and portable storage.
+
+The [VS Code extension](extensions/vscode/README.md) lives in this package's
+source directory. It starts the workspace server and uses its HTTP API.
+It is built and distributed separately as a VSIX, outside both Python wheels
+and source distributions.
+
+In the browser's code and diff viewer, right-click **Insert into chat**, or
+select text and click the toolbar button, to insert context into the current
+conversation's draft. Context uses the full view label, including both revisions
+of a diff, and identifies the selected side. It includes either selected text and
+its range, or only the cursor position. Context appears as a separate block among the message
+text; click a block to edit or remove it before sending.
+
+Workspace sessions include `/link` and `/unlink` for Feishu. Python callers use
+`pycodex_ws.build_runtime(agent)` for the same assembly, or
+`from pycodex_ws.ipython import ipython_agent` inside an IPython session.
+
+For initial Feishu user authorization, run the module included in this package:
+
+```bash
+python3 -m pycodex_ws.feishu_oauth
+```
+
+It reads app credentials from `~/.codex/.env` and stores the refresh token in
+`~/.codex/.feishu_refresh_token` with mode `0600`. `--help` works without
+credentials. In a development checkout, use
+`uv run --dev python -m pycodex_ws.feishu_oauth`.
+
+Use a filename prefix and a separate Canvas switch in `workspaces.json`:
+
+```json
+{
+  "workspaces": [
+    {"id": "demo", "work_dir": ".", "state_path": "demo", "enable_board": true}
+  ]
+}
+```
+
+Start it with `pycodex-ws --workspace-config workspaces.json`.
+Relative paths resolve from the configuration directory. This example uses
+`demo.pycodex-ws.json` for session titles and rollout references,
+`demo.pycodex-views.json` for file views, and `demo.html` for Canvas.
+All suffixes are appended to the complete prefix, including any dots.
+The resolved `state_path` identifies the workspace; two entries cannot share it.
+Creating a workspace through the management page or API without a prefix
+generates a `/tmp/pcws-*` prefix and saves it in the configuration.
+
+`enable_board` defaults to `true`. Setting it to `false` disables the Canvas
+tab, HTML/image/status routes, polling and Canvas context injection. Sessions
+and file views still save and restore from the same prefix, so changing this
+switch preserves their state.
+
+Existing `board: "demo.html"` configurations load as `state_path: "demo"`.
+Existing `board: false` entries use `<config-stem>.<workspace-id>` as their
+prefix, preserving their session index. Loading leaves files in place; later
+configuration saves write only `state_path` and `enable_board`.
+Do not mix the old and new fields. For an old Canvas path with an extension
+other than `.html`, rename it to `<prefix>.html` and set `state_path` explicitly.
+Conversation contents remain in their original rollout files.
+Malformed session state stops restoration and leaves the saved file intact.
+
+Both packages are developed in the same repository. Run `uv sync --dev` at its
+root to install both, then `uv run pycodex-ws --help`. Build this package with
+`uv build packages/pycodex-ws`.
+
+Run `uv run --dev pytest packages/pycodex-ws/tests` from the repository root for
+workspace, Feishu, IPython and cross-frontend integration tests. Core tests live
+in the root `tests/` directory and use the independent `test` dependency group.
+`uv run --dev pytest` runs both suites; see [test documentation](../../tests/TESTS.md).

pycodex_ws-0.4.0/pycodex_ws/__init__.py

@@ -0,0 +1,46 @@
+"""Workspace integrations for python-codex."""
+
+from pycodex.bootstrap import build_runtime as build_core_runtime
+
+
+def build_runtime(agent):
+    runtime = build_core_runtime(agent)
+    link = None
+
+    async def unlink(argument):
+        nonlocal link
+        if argument:
+            raise ValueError("Usage: /unlink")
+        if link is None:
+            return {"kind": "connection", "lines": ["No Feishu card is linked."]}
+        link.detach()
+        link = None
+        return {"kind": "connection", "lines": ["Unlinked Feishu card."]}
+
+    async def connect(target):
+        nonlocal link
+        if not target:
+            raise ValueError("Usage: /link <feishu-email|open_id|chat_id>")
+        if link is not None:
+            raise RuntimeError("A Feishu card is already linked. Use /unlink first.")
+        from .feishu_link import PycodexRuntimeLink
+
+        link = await PycodexRuntimeLink(runtime, target).start_async()
+        return {
+            "kind": "connection",
+            "lines": [
+                "Linked Feishu card: session_key={0} message_id={1}".format(
+                    link.session_key,
+                    link.message_id or "-",
+                ),
+            ],
+        }
+
+    async def close_link():
+        if link is not None:
+            await unlink("")
+
+    runtime.register_command("link", connect)
+    runtime.register_command("unlink", unlink)
+    runtime.add_close_handler(close_link)
+    return runtime