codex-backend-sdk 0.1.1__tar.gz → 0.2.0__tar.gz

codex_backend_sdk-0.2.0/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "python-envs.defaultEnvManager": "ms-python.python:pyenv"
+}

codex_backend_sdk-0.2.0/PKG-INFO

@@ -0,0 +1,190 @@
+Metadata-Version: 2.4
+Name: codex-backend-sdk
+Version: 0.2.0
+Summary: Unofficial Python SDK for the ChatGPT Codex backend API
+License: MIT
+License-File: LICENSE
+Keywords: chatgpt,codex,llm,openai,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: pydantic>=2.0
+Requires-Dist: requests>=2.28
+Provides-Extra: dev
+Requires-Dist: openai>=1.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Provides-Extra: openai
+Requires-Dist: openai>=1.0; extra == 'openai'
+Description-Content-Type: text/markdown
+
+# codex-backend-sdk
+
+Unofficial Python SDK for the ChatGPT Codex backend API
+(`chatgpt.com/backend-api/codex`).
+
+This package mirrors the official OpenAI Python SDK shape for the API surface
+that the Codex backend exposes. Use `OpenAI`, `client.responses.create(...)`,
+and `client.models.list()` just as you would with `openai-python`, with
+Codex-specific authentication and backend limitations under the hood.
+
+> **Requirements:** a ChatGPT Plus, Pro, or Enterprise subscription.
+> Authentication goes through ChatGPT OAuth and stores tokens in
+> `~/.codex/auth.json`.
+
+> **Disclaimer:** This is an independent, community-maintained library that
+> reverse-engineers undocumented endpoints of `chatgpt.com`. It is not
+> affiliated with, endorsed by, or supported by OpenAI.
+
+## Installation
+
+```bash
+git clone https://github.com/B4PT0R/codex-backend-sdk.git
+cd codex-backend-sdk
+pip install -e .
+```
+
+## Basic Usage
+
+```python
+from codex_backend_sdk import OpenAI
+
+client = OpenAI().authenticate()
+
+response = client.responses.create(
+    model="gpt-5.4",
+    input="Explain quicksort in one paragraph.",
+)
+
+print(response.output_text)
+```
+
+## Streaming
+
+```python
+stream = client.responses.create(
+    model="gpt-5.4",
+    input="Say 'hi' five times.",
+    stream=True,
+)
+
+for event in stream:
+    if event.type in {"response.output_text.delta", "response.content_part.delta"}:
+        delta = event.delta
+        print(delta if isinstance(delta, str) else delta.get("text", ""), end="")
+```
+
+## Models
+
+```python
+models = client.models.list()
+for model in models:
+    print(model.id, model.display_name, model.context_window)
+
+info = client.models.retrieve("gpt-5.4")
+```
+
+## Multi-Turn Input
+
+The Codex backend does not expose `previous_response_id`, so pass prior
+input/output items explicitly.
+
+```python
+history = [
+    {"role": "user", "content": "My name is Alice. Say OK."},
+]
+
+reply1 = client.responses.create(input=history).output_text
+history.append({"role": "assistant", "content": reply1})
+history.append({"role": "user", "content": "What is my name?"})
+
+reply2 = client.responses.create(input=history).output_text
+print(reply2)
+```
+
+## Function Calling
+
+```python
+import json
+
+tools = [{
+    "type": "function",
+    "name": "get_weather",
+    "description": "Get the current weather for a city.",
+    "parameters": {
+        "type": "object",
+        "properties": {"city": {"type": "string"}},
+        "required": ["city"],
+        "additionalProperties": False,
+    },
+}]
+
+first = client.responses.create(
+    input="What's the weather in Paris?",
+    tools=tools,
+)
+
+call = next(item for item in first.output if item["type"] == "function_call")
+result = {"temperature": 18, "unit": "celsius", "condition": "cloudy"}
+
+second = client.responses.create(
+    input=[
+        call,
+        {
+            "type": "function_call_output",
+            "call_id": call["call_id"],
+            "output": json.dumps(result),
+        },
+    ],
+    tools=tools,
+)
+
+print(second.output_text)
+```
+
+## Structured Output
+
+```python
+schema = {
+    "title": "person",
+    "type": "object",
+    "properties": {
+        "name": {"type": "string"},
+        "age": {"type": "integer"},
+    },
+    "required": ["name", "age"],
+    "additionalProperties": False,
+}
+
+response = client.responses.create(
+    input="Extract: Bob is 42 years old.",
+    text={
+        "format": {
+            "type": "json_schema",
+            "name": "person",
+            "schema": schema,
+            "strict": True,
+        }
+    },
+)
+```
+
+## Codex-Specific Endpoints
+
+Codex-only operations live under `client.codex`.
+
+```python
+quota = client.codex.usage()
+```
+
+The backend currently rejects some official Responses parameters, including
+`temperature`, `top_p`, `max_output_tokens`, `metadata`, `user`,
+`safety_identifier`, `truncation`, and `previous_response_id`. The SDK raises
+`CodexBackendUnsupportedParameterError` for those instead of silently dropping
+them.

codex_backend_sdk-0.2.0/README.md

@@ -0,0 +1,164 @@
+# codex-backend-sdk
+
+Unofficial Python SDK for the ChatGPT Codex backend API
+(`chatgpt.com/backend-api/codex`).
+
+This package mirrors the official OpenAI Python SDK shape for the API surface
+that the Codex backend exposes. Use `OpenAI`, `client.responses.create(...)`,
+and `client.models.list()` just as you would with `openai-python`, with
+Codex-specific authentication and backend limitations under the hood.
+
+> **Requirements:** a ChatGPT Plus, Pro, or Enterprise subscription.
+> Authentication goes through ChatGPT OAuth and stores tokens in
+> `~/.codex/auth.json`.
+
+> **Disclaimer:** This is an independent, community-maintained library that
+> reverse-engineers undocumented endpoints of `chatgpt.com`. It is not
+> affiliated with, endorsed by, or supported by OpenAI.
+
+## Installation
+
+```bash
+git clone https://github.com/B4PT0R/codex-backend-sdk.git
+cd codex-backend-sdk
+pip install -e .
+```
+
+## Basic Usage
+
+```python
+from codex_backend_sdk import OpenAI
+
+client = OpenAI().authenticate()
+
+response = client.responses.create(
+    model="gpt-5.4",
+    input="Explain quicksort in one paragraph.",
+)
+
+print(response.output_text)
+```
+
+## Streaming
+
+```python
+stream = client.responses.create(
+    model="gpt-5.4",
+    input="Say 'hi' five times.",
+    stream=True,
+)
+
+for event in stream:
+    if event.type in {"response.output_text.delta", "response.content_part.delta"}:
+        delta = event.delta
+        print(delta if isinstance(delta, str) else delta.get("text", ""), end="")
+```
+
+## Models
+
+```python
+models = client.models.list()
+for model in models:
+    print(model.id, model.display_name, model.context_window)
+
+info = client.models.retrieve("gpt-5.4")
+```
+
+## Multi-Turn Input
+
+The Codex backend does not expose `previous_response_id`, so pass prior
+input/output items explicitly.
+
+```python
+history = [
+    {"role": "user", "content": "My name is Alice. Say OK."},
+]
+
+reply1 = client.responses.create(input=history).output_text
+history.append({"role": "assistant", "content": reply1})
+history.append({"role": "user", "content": "What is my name?"})
+
+reply2 = client.responses.create(input=history).output_text
+print(reply2)
+```
+
+## Function Calling
+
+```python
+import json
+
+tools = [{
+    "type": "function",
+    "name": "get_weather",
+    "description": "Get the current weather for a city.",
+    "parameters": {
+        "type": "object",
+        "properties": {"city": {"type": "string"}},
+        "required": ["city"],
+        "additionalProperties": False,
+    },
+}]
+
+first = client.responses.create(
+    input="What's the weather in Paris?",
+    tools=tools,
+)
+
+call = next(item for item in first.output if item["type"] == "function_call")
+result = {"temperature": 18, "unit": "celsius", "condition": "cloudy"}
+
+second = client.responses.create(
+    input=[
+        call,
+        {
+            "type": "function_call_output",
+            "call_id": call["call_id"],
+            "output": json.dumps(result),
+        },
+    ],
+    tools=tools,
+)
+
+print(second.output_text)
+```
+
+## Structured Output
+
+```python
+schema = {
+    "title": "person",
+    "type": "object",
+    "properties": {
+        "name": {"type": "string"},
+        "age": {"type": "integer"},
+    },
+    "required": ["name", "age"],
+    "additionalProperties": False,
+}
+
+response = client.responses.create(
+    input="Extract: Bob is 42 years old.",
+    text={
+        "format": {
+            "type": "json_schema",
+            "name": "person",
+            "schema": schema,
+            "strict": True,
+        }
+    },
+)
+```
+
+## Codex-Specific Endpoints
+
+Codex-only operations live under `client.codex`.
+
+```python
+quota = client.codex.usage()
+```
+
+The backend currently rejects some official Responses parameters, including
+`temperature`, `top_p`, `max_output_tokens`, `metadata`, `user`,
+`safety_identifier`, `truncation`, and `previous_response_id`. The SDK raises
+`CodexBackendUnsupportedParameterError` for those instead of silently dropping
+them.

{codex_backend_sdk-0.1.1 → codex_backend_sdk-0.2.0}/codex_backend_sdk/__init__.py

@@ -8,59 +8,53 @@ to OpenAI's Terms of Use (https://openai.com/policies/terms-of-use).
 Endpoints may change or break without notice.
 
 Quickstart:
-    from codex_backend_sdk import CodexClient
+    from codex_backend_sdk import OpenAI
 
-    client = CodexClient().authenticate()   # opens browser on first run
+    client = OpenAI().authenticate()        # opens browser on first run
     # subsequent runs load & refresh tokens automatically
 
-    for event in client.stream("Explain quicksort"):
-        ...
+    response = client.responses.create(input="Explain quicksort")
+    print(response.output_text)
 """
 
-__version__ = "0.1.1"
+__version__ = "0.2.0"
 
 from .oauth import run_oauth_flow, refresh_access_token, obtain_api_key
 from .storage import load_tokens, save_tokens, TokenStore
 from .codex_client import (
+    CodexBackendUnsupportedParameterError,
+    CodexBaseModel,
     ReasoningEffort,
     ReasoningSummary,
-    Verbosity,
     ServiceTier,
+    Verbosity,
     CodexClient,
-    ModelInfo,
-    ReasoningLevel,
-    TextDelta,
-    ReasoningDelta,
-    ToolCall,
-    OutputItem,
-    TokenUsage,
-    ResponseCompleted,
-    ResponseFailed,
-    ResponseAborted,
-    CompactionResult,
-    RealtimeCallResult,
+    OpenAI,
+    Model,
+    Response,
+    ResponseStreamEvent,
+    ResponseUsage,
+    SyncPage,
+    CompactedResponse,
     image_url,
     image_b64,
 )
 
 __all__ = [
     "CodexClient",
+    "OpenAI",
+    "CodexBackendUnsupportedParameterError",
+    "CodexBaseModel",
+    "Model",
+    "Response",
+    "ResponseStreamEvent",
+    "ResponseUsage",
+    "SyncPage",
+    "CompactedResponse",
     "ReasoningEffort",
     "ReasoningSummary",
-    "Verbosity",
     "ServiceTier",
-    "ModelInfo",
-    "ReasoningLevel",
-    "TextDelta",
-    "ReasoningDelta",
-    "ToolCall",
-    "OutputItem",
-    "TokenUsage",
-    "ResponseCompleted",
-    "ResponseFailed",
-    "ResponseAborted",
-    "CompactionResult",
-    "RealtimeCallResult",
+    "Verbosity",
     "image_url",
     "image_b64",
     "run_oauth_flow",