{"id":51391067,"url":"https://github.com/hyperb1iss/codex-sdk-python","last_synced_at":"2026-07-03T23:33:36.886Z","repository":{"id":356472874,"uuid":"1128626652","full_name":"hyperb1iss/codex-sdk-python","owner":"hyperb1iss","description":null,"archived":false,"fork":false,"pushed_at":"2026-01-05T23:25:07.000Z","size":21,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-30T01:06:16.297Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hyperb1iss.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-05T23:24:45.000Z","updated_at":"2026-01-05T23:25:11.000Z","dependencies_parsed_at":"2026-05-08T09:00:35.282Z","dependency_job_id":null,"html_url":"https://github.com/hyperb1iss/codex-sdk-python","commit_stats":null,"previous_names":["hyperb1iss/codex-sdk-python"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hyperb1iss/codex-sdk-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperb1iss%2Fcodex-sdk-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperb1iss%2Fcodex-sdk-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperb1iss%2Fcodex-sdk-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperb1iss%2Fcodex-sdk-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hyperb1iss","download_url":"https://codeload.github.com/hyperb1iss/codex-sdk-python/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperb1iss%2Fcodex-sdk-python/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35105483,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-03T02:00:05.635Z","response_time":110,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-07-03T23:33:36.095Z","updated_at":"2026-07-03T23:33:36.877Z","avatar_url":"https://github.com/hyperb1iss.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Codex Python SDK\n\nThis is a Python SDK for interacting with the Codex agent by wrapping the local `codex` CLI.\n\nIt mirrors the TypeScript SDK in the main Codex repo at a high level:\n\n- Spawns `codex exec --experimental-json`\n- Writes the prompt to stdin\n- Reads JSONL events from stdout\n\n## Requirements\n\n- Python 3.9+\n- `codex` installed and available on `PATH` (or pass `CodexOptions(codex_path_override=...)`)\n\n## Development\n\nFrom the repo root:\n\n```bash\nuv sync\nuv run ruff format .\nuv run ruff check .\nuv run pyright\nuv run python -m unittest discover -s tests -p \"test_*.py\"\n```\n\n## Quickstart\n\n```python\nfrom codex_sdk import Codex\n\ncodex = Codex()\nthread = codex.start_thread()\nturn = thread.run(\"Summarize repository status\")\n\nprint(turn.final_response)\nprint(turn.items)\n```\n\n## Streaming responses\n\n```python\nfrom codex_sdk import Codex\n\ncodex = Codex()\nthread = codex.start_thread()\nstreamed = thread.run_streamed(\"Diagnose the test failure and propose a fix\")\n\nfor event in streamed.events:\n    if event[\"type\"] == \"item.completed\":\n        print(event[\"item\"])\n```\n\n## Structured output\n\n```python\nfrom codex_sdk import Codex, TurnOptions\n\nschema = {\n  \"type\": \"object\",\n  \"properties\": {\"summary\": {\"type\": \"string\"}},\n  \"required\": [\"summary\"],\n  \"additionalProperties\": False,\n}\n\ncodex = Codex()\nthread = codex.start_thread()\nturn = thread.run(\"Summarize repository status\", TurnOptions(output_schema=schema))\nprint(turn.final_response)\n```\n\n## Images\n\n```python\nfrom codex_sdk import Codex\n\ncodex = Codex()\nthread = codex.start_thread()\nturn = thread.run([\n    {\"type\": \"text\", \"text\": \"Describe these screenshots\"},\n    {\"type\": \"local_image\", \"path\": \"./ui.png\"},\n])\nprint(turn.final_response)\n```\n\n## Resuming an existing thread\n\n```python\nimport os\nfrom codex_sdk import Codex\n\ncodex = Codex()\nthread = codex.resume_thread(os.environ[\"CODEX_THREAD_ID\"])\nturn = thread.run(\"Continue from where we left off\")\n```\n\n## Working directory controls\n\nCodex runs in the current working directory by default. To avoid unrecoverable errors, Codex requires the working directory to be a Git repository. You can skip the Git repository check by passing `skip_git_repo_check` when creating a thread.\n\n```python\nfrom codex_sdk import Codex, ThreadOptions\n\ncodex = Codex()\nthread = codex.start_thread(\n    ThreadOptions(working_directory=\"/path/to/project\", skip_git_repo_check=True)\n)\nturn = thread.run(\"Summarize repository status\")\nprint(turn.final_response)\n```\n\n## Controlling the Codex CLI environment\n\nBy default, the Codex CLI inherits the Python process environment. Provide the optional `env` parameter when instantiating the `Codex` client to fully control which variables the CLI receives—useful for sandboxed hosts.\n\n```python\nfrom codex_sdk import Codex, CodexOptions\n\ncodex = Codex(CodexOptions(env={\"PATH\": \"/usr/local/bin\"}))\nthread = codex.start_thread()\nturn = thread.run(\"Summarize repository status\")\nprint(turn.final_response)\n```\n\nThe SDK still injects required variables (such as `OPENAI_BASE_URL` and `CODEX_API_KEY`) on top of the environment you provide.\n\n## Cancellation and timeouts\n\n```python\nfrom codex_sdk import CancelToken, Codex, TurnOptions\n\ntoken = CancelToken()\ncodex = Codex()\nthread = codex.start_thread()\n\n# token.cancel() from another thread to abort.\nturn = thread.run(\"Long-running request\", TurnOptions(timeout_s=30, cancel_token=token))\n```\n\n## Asyncio\n\n```python\nimport asyncio\nfrom codex_sdk import Codex\n\nasync def main() -\u003e None:\n    codex = Codex()\n    thread = codex.start_thread()\n    turn = await thread.run_async(\"Summarize repository status\")\n    print(turn.final_response)\n\nasyncio.run(main())\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperb1iss%2Fcodex-sdk-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhyperb1iss%2Fcodex-sdk-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperb1iss%2Fcodex-sdk-python/lists"}