Skip to main content

Python SDK wrapper around codex exec with bundled skill/docs scaffolding CLI.

Project description

codex-local-sdk-python

PyPI Version Python Versions Unit Tests License

codex-local-sdk-python packages this repository's local codex_local_sdk module as an installable PyPI distribution and adds a companion CLI:

  • codex-sdk skill copies the bundled codex-local-sdk-usage skill to .agents/skills/.
  • codex-sdk docs copies bundled documentation to codex-sdk-documentation/.

Project policies:

  • Contributing: CONTRIBUTING.md
  • Security: SECURITY.md
  • License: LICENSE (MIT)

Install

pip install codex-local-sdk-python

Python usage

from codex_local_sdk import CodexExecRequest, CodexLocalClient

client = CodexLocalClient()
result = client.run(CodexExecRequest(prompt="Summarize this repo"), timeout_seconds=120)
print(result.final_message)

CLI

codex-sdk --help
codex-sdk skill
codex-sdk docs

Command details:

  • codex-sdk skill copies codex-local-sdk-usage to .agents/skills/
  • codex-sdk docs copies docs to codex-sdk-documentation/
  • use --output <dir> to choose destination root
  • use --force to overwrite existing files

Examples:

codex-sdk skill --output .
codex-sdk docs --output .
codex-sdk skill --output /path/to/project --force

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_local_sdk_python-0.1.1.tar.gz (39.4 kB view details)

Uploaded Source

Built Distribution

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

codex_local_sdk_python-0.1.1-py3-none-any.whl (58.0 kB view details)

Uploaded Python 3

File details

Details for the file codex_local_sdk_python-0.1.1.tar.gz.

File metadata

  • Download URL: codex_local_sdk_python-0.1.1.tar.gz
  • Upload date:
  • Size: 39.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for codex_local_sdk_python-0.1.1.tar.gz
Algorithm Hash digest
SHA256 aa579e9f33b3438ea038e3b1a6f8c5e9a18fa97a2f7ad54900b1f93c9b6a7207
MD5 8701fbf686957ccf58418a7a2d8d5656
BLAKE2b-256 4f57f9f8022f78b3785e75a9e47e89eb331a4ca774f4af401fc46120a3f2924e

See more details on using hashes here.

File details

Details for the file codex_local_sdk_python-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for codex_local_sdk_python-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 51410832960caae9fb2f8ce2d4d2cbe1c227ba4bbff323dca6a0850ceb17e40d
MD5 218a12a7b411b1b352568698592322cf
BLAKE2b-256 b6965f7d4b83647d2ccd987ee5bfb40c1f1a3e6612f2d7c4798f8898084ab21f

See more details on using hashes here.

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