codex-client-provider 0.1.0__tar.gz

codex_client_provider-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://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 2026 Google LLC.
+
+   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
+
+       https://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.

codex_client_provider-0.1.0/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.4
+Name: codex-client-provider
+Version: 0.1.0
+Summary: Reusable LangChain provider for a locally signed-in Codex App Server
+Author: Codex Client Provider contributors
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/HJunLong601/codex-client-provider
+Project-URL: Documentation, https://github.com/HJunLong601/codex-client-provider#readme
+Project-URL: Issues, https://github.com/HJunLong601/codex-client-provider/issues
+Project-URL: Repository, https://github.com/HJunLong601/codex-client-provider
+Keywords: codex,langchain,openai,app-server,llm
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+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 :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: langchain-core>=1.0.0
+Requires-Dist: pillow>=10.0.0
+Requires-Dist: pydantic>=2.7.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2.2; extra == "dev"
+Requires-Dist: pyright>=1.1.390; extra == "dev"
+Requires-Dist: pytest>=8.3; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.24; extra == "dev"
+Requires-Dist: ruff>=0.9; extra == "dev"
+Requires-Dist: twine>=6.0; extra == "dev"
+Dynamic: license-file
+
+# Codex Client Provider
+
+[![CI](https://github.com/HJunLong601/codex-client-provider/actions/workflows/ci.yml/badge.svg)](https://github.com/HJunLong601/codex-client-provider/actions/workflows/ci.yml)
+[![Python](https://img.shields.io/pypi/pyversions/codex-client-provider.svg)](https://pypi.org/project/codex-client-provider/)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+
+Reusable Python and LangChain adapter for the official `codex app-server`
+protocol. It lets a local application use the Codex model access already managed
+by the installed Codex client, without asking the user for an OpenAI API key.
+
+The provider never reads, copies, logs, or stores Codex authentication files. It
+starts `codex app-server`, communicates through JSONL over stdio, and leaves
+authentication and account policy enforcement to the Codex client.
+
+> This is an unofficial community project. Codex and OpenAI are trademarks of
+> OpenAI. See the official [Codex App Server documentation](https://developers.openai.com/codex/app-server/)
+> for the protocol and compatibility guidance.
+
+## Features
+
+- Persistent App Server process with request correlation and clean shutdown.
+- LangChain `BaseChatModel` with sync and async invocation.
+- Text, local image, and data URL image inputs.
+- LangChain tool calls while keeping tool execution inside the host application.
+- Structured output through Codex output schemas.
+- Bounded image resizing and JPEG compression with temporary-file cleanup.
+- Model, reasoning effort, timeout, client identity, and Codex binary overrides.
+- Windows, macOS, and Linux support when the Codex CLI is available.
+
+```mermaid
+flowchart LR
+    A[Host application] --> B[Codex Client Provider]
+    B -->|JSONL over stdio| C[codex app-server]
+    C --> D[Existing Codex login]
+    D --> E[Codex model]
+    B -->|tool call request| A
+```
+
+## Requirements
+
+- Python 3.10 or newer.
+- A compatible Codex CLI or Codex desktop installation.
+- An active Codex login.
+
+Verify the login before using the provider:
+
+```console
+codex login
+codex login status
+```
+
+## Install
+
+Install the current source checkout:
+
+```console
+python -m pip install .
+```
+
+After the first PyPI release, install it with:
+
+```console
+python -m pip install codex-client-provider
+```
+
+## Basic usage
+
+```python
+from codex_client_provider import CodexAppServerChatModel
+
+model = CodexAppServerChatModel(
+    model_name="default",
+    reasoning_effort="low",
+    timeout_seconds=120,
+)
+response = model.invoke("Return a concise status message.")
+print(response.content)
+```
+
+The provider also supports LangChain tools:
+
+```python
+from langchain_core.tools import tool
+from codex_client_provider import CodexAppServerChatModel
+
+
+@tool
+def lookup_temperature(city: str) -> str:
+    """Return a sample temperature for a city."""
+    return f"{city}: 23 C"
+
+
+model = CodexAppServerChatModel().bind_tools([lookup_temperature])
+message = model.invoke("What is the temperature in Shanghai?")
+for call in message.tool_calls:
+    result = lookup_temperature.invoke(call["args"])
+    print(result)
+```
+
+The host application remains responsible for running tools. The provider only
+asks Codex to return a LangChain-compatible tool call, which prevents the model
+from silently using Codex built-in shell, browser, or file tools on the host's
+behalf.
+
+## Configuration
+
+| Setting | Default | Purpose |
+| --- | --- | --- |
+| `CODEX_CLIENT_BIN` | Auto-detected | Absolute path to `codex` or `codex.exe`. |
+| `CODEX_CLIENT_IMAGE_MAX_EDGE` | `1600` | Maximum image width or height in pixels. |
+| `CODEX_CLIENT_IMAGE_MAX_BYTES` | `786432` | Target maximum encoded image size. |
+| `CODEX_CLIENT_IMAGE_JPEG_QUALITY` | `82` | Initial JPEG quality for compressed images. |
+
+The constructor accepts `model_name`, `reasoning_effort`, `timeout_seconds`,
+`codex_binary`, and `service_name`. The provider uses the App Server's read-only
+sandbox for model turns.
+
+For compatibility with the original Artemis integration, the legacy
+`ARTEMIS_CODEX_*` environment variable names are accepted when the corresponding
+`CODEX_CLIENT_*` variable is absent.
+
+## Development
+
+```console
+python -m pip install -e ".[dev]"
+ruff check .
+ruff format --check .
+pyright
+pytest
+python -m build
+twine check dist/*
+```
+
+Run the opt-in live smoke test only on a machine with a working Codex login:
+
+```console
+python scripts/smoke.py
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the release workflow and
+[SECURITY.md](SECURITY.md) for the authentication boundary.

codex_client_provider-0.1.0/README.md

@@ -0,0 +1,141 @@
+# Codex Client Provider
+
+[![CI](https://github.com/HJunLong601/codex-client-provider/actions/workflows/ci.yml/badge.svg)](https://github.com/HJunLong601/codex-client-provider/actions/workflows/ci.yml)
+[![Python](https://img.shields.io/pypi/pyversions/codex-client-provider.svg)](https://pypi.org/project/codex-client-provider/)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+
+Reusable Python and LangChain adapter for the official `codex app-server`
+protocol. It lets a local application use the Codex model access already managed
+by the installed Codex client, without asking the user for an OpenAI API key.
+
+The provider never reads, copies, logs, or stores Codex authentication files. It
+starts `codex app-server`, communicates through JSONL over stdio, and leaves
+authentication and account policy enforcement to the Codex client.
+
+> This is an unofficial community project. Codex and OpenAI are trademarks of
+> OpenAI. See the official [Codex App Server documentation](https://developers.openai.com/codex/app-server/)
+> for the protocol and compatibility guidance.
+
+## Features
+
+- Persistent App Server process with request correlation and clean shutdown.
+- LangChain `BaseChatModel` with sync and async invocation.
+- Text, local image, and data URL image inputs.
+- LangChain tool calls while keeping tool execution inside the host application.
+- Structured output through Codex output schemas.
+- Bounded image resizing and JPEG compression with temporary-file cleanup.
+- Model, reasoning effort, timeout, client identity, and Codex binary overrides.
+- Windows, macOS, and Linux support when the Codex CLI is available.
+
+```mermaid
+flowchart LR
+    A[Host application] --> B[Codex Client Provider]
+    B -->|JSONL over stdio| C[codex app-server]
+    C --> D[Existing Codex login]
+    D --> E[Codex model]
+    B -->|tool call request| A
+```
+
+## Requirements
+
+- Python 3.10 or newer.
+- A compatible Codex CLI or Codex desktop installation.
+- An active Codex login.
+
+Verify the login before using the provider:
+
+```console
+codex login
+codex login status
+```
+
+## Install
+
+Install the current source checkout:
+
+```console
+python -m pip install .
+```
+
+After the first PyPI release, install it with:
+
+```console
+python -m pip install codex-client-provider
+```
+
+## Basic usage
+
+```python
+from codex_client_provider import CodexAppServerChatModel
+
+model = CodexAppServerChatModel(
+    model_name="default",
+    reasoning_effort="low",
+    timeout_seconds=120,
+)
+response = model.invoke("Return a concise status message.")
+print(response.content)
+```
+
+The provider also supports LangChain tools:
+
+```python
+from langchain_core.tools import tool
+from codex_client_provider import CodexAppServerChatModel
+
+
+@tool
+def lookup_temperature(city: str) -> str:
+    """Return a sample temperature for a city."""
+    return f"{city}: 23 C"
+
+
+model = CodexAppServerChatModel().bind_tools([lookup_temperature])
+message = model.invoke("What is the temperature in Shanghai?")
+for call in message.tool_calls:
+    result = lookup_temperature.invoke(call["args"])
+    print(result)
+```
+
+The host application remains responsible for running tools. The provider only
+asks Codex to return a LangChain-compatible tool call, which prevents the model
+from silently using Codex built-in shell, browser, or file tools on the host's
+behalf.
+
+## Configuration
+
+| Setting | Default | Purpose |
+| --- | --- | --- |
+| `CODEX_CLIENT_BIN` | Auto-detected | Absolute path to `codex` or `codex.exe`. |
+| `CODEX_CLIENT_IMAGE_MAX_EDGE` | `1600` | Maximum image width or height in pixels. |
+| `CODEX_CLIENT_IMAGE_MAX_BYTES` | `786432` | Target maximum encoded image size. |
+| `CODEX_CLIENT_IMAGE_JPEG_QUALITY` | `82` | Initial JPEG quality for compressed images. |
+
+The constructor accepts `model_name`, `reasoning_effort`, `timeout_seconds`,
+`codex_binary`, and `service_name`. The provider uses the App Server's read-only
+sandbox for model turns.
+
+For compatibility with the original Artemis integration, the legacy
+`ARTEMIS_CODEX_*` environment variable names are accepted when the corresponding
+`CODEX_CLIENT_*` variable is absent.
+
+## Development
+
+```console
+python -m pip install -e ".[dev]"
+ruff check .
+ruff format --check .
+pyright
+pytest
+python -m build
+twine check dist/*
+```
+
+Run the opt-in live smoke test only on a machine with a working Codex login:
+
+```console
+python scripts/smoke.py
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the release workflow and
+[SECURITY.md](SECURITY.md) for the authentication boundary.

codex_client_provider-0.1.0/pyproject.toml

@@ -0,0 +1,71 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "codex-client-provider"
+version = "0.1.0"
+description = "Reusable LangChain provider for a locally signed-in Codex App Server"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [
+    { name = "Codex Client Provider contributors" },
+]
+keywords = ["codex", "langchain", "openai", "app-server", "llm"]
+dependencies = [
+    "langchain-core>=1.0.0",
+    "pillow>=10.0.0",
+    "pydantic>=2.7.0",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[project.urls]
+Homepage = "https://github.com/HJunLong601/codex-client-provider"
+Documentation = "https://github.com/HJunLong601/codex-client-provider#readme"
+Issues = "https://github.com/HJunLong601/codex-client-provider/issues"
+Repository = "https://github.com/HJunLong601/codex-client-provider"
+
+[project.optional-dependencies]
+dev = [
+    "build>=1.2.2",
+    "pyright>=1.1.390",
+    "pytest>=8.3",
+    "pytest-asyncio>=0.24",
+    "ruff>=0.9",
+    "twine>=6.0",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+codex_client_provider = ["py.typed"]
+
+[tool.pyright]
+include = ["src", "tests"]
+extraPaths = ["src"]
+pythonVersion = "3.10"
+typeCheckingMode = "standard"
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I"]

codex_client_provider-0.1.0/setup.cfg

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

codex_client_provider-0.1.0/src/codex_client_provider/__init__.py

@@ -0,0 +1,25 @@
+"""Public API for the reusable Codex App Server provider."""
+
+from codex_client_provider.langchain import (
+    CODEX_IMAGE_JPEG_QUALITY,
+    CODEX_IMAGE_MAX_BYTES,
+    CODEX_IMAGE_MAX_EDGE,
+    CodexAppServerChatModel,
+    CodexAppServerClient,
+    CodexAppServerError,
+    codex_client_status,
+    find_codex_binary,
+)
+
+__all__ = [
+    "CODEX_IMAGE_JPEG_QUALITY",
+    "CODEX_IMAGE_MAX_BYTES",
+    "CODEX_IMAGE_MAX_EDGE",
+    "CodexAppServerChatModel",
+    "CodexAppServerClient",
+    "CodexAppServerError",
+    "codex_client_status",
+    "find_codex_binary",
+]
+
+__version__ = "0.1.0"