Skip to main content

Unofficial Python SDK for the OpenAI Codex CLI.

Project description

codex-sdk-unofficial

Unofficial, community-maintained Python SDK for the Codex CLI.

This is not an official OpenAI SDK.

Documentation

Full docs site (UV-first, beginner-first):

Local docs preview:

uv run --group docs mkdocs serve

Quickstart (UV-First)

Assumes you are already inside an existing UV-managed project.

uv add codex-sdk-unofficial
uv run python -c "from codex_sdk import Codex; print('import-ok')"
from codex_sdk import Codex

codex = Codex()
thread = codex.start_thread()
turn = thread.run("Diagnose the test failure and propose a fix", stream=True)

print(turn.final_response)
print(turn.items)

Run:

uv run python your_script.py

Package Info

  • Package name: codex-sdk-unofficial
  • Import name: codex_sdk
  • Current version: 0.1.3

Dev Commands

PYTHONPATH=src uv run pytest -q
uv run --group docs mkdocs build --strict
uv run --with build python -m build

Publishing

Tag pushes (v*) trigger .github/workflows/publish.yml.

Manual upload fallback:

uv run --with twine twine upload dist/*

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

codex_sdk_unofficial-0.1.3.tar.gz (64.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

codex_sdk_unofficial-0.1.3-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

Details for the file codex_sdk_unofficial-0.1.3.tar.gz.

File metadata

  • Download URL: codex_sdk_unofficial-0.1.3.tar.gz
  • Upload date:
  • Size: 64.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for codex_sdk_unofficial-0.1.3.tar.gz
Algorithm Hash digest
SHA256 dce43b63697b60b8fa824bd7ad56f3c3a794b3bf08404dae92d0fd17ee05dd38
MD5 c040b13d30a1f7567fe34a4e93ae99bb
BLAKE2b-256 249d4e63ce2b1558bf82a7c5823df16cd6b05c66775429828e78c22dea0fe7b1

See more details on using hashes here.

Provenance

The following attestation bundles were made for codex_sdk_unofficial-0.1.3.tar.gz:

Publisher: publish.yml on Goodbuilder34/codex-sdk-unofficial

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file codex_sdk_unofficial-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for codex_sdk_unofficial-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 80396af0969fe9f0c052321a784b42ba0f726ae8c227c02a54b16745500f6ab4
MD5 e9f1b4c0b5371fdbb3d176d8767a005c
BLAKE2b-256 3407b37bb114f19f55ae5365c6d0e093b0e0a209d52191c9310c2df9b8b0e8c6

See more details on using hashes here.

Provenance

The following attestation bundles were made for codex_sdk_unofficial-0.1.3-py3-none-any.whl:

Publisher: publish.yml on Goodbuilder34/codex-sdk-unofficial

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page