codex-pal 0.1.0__py3-none-win32.whl

codex_pal-0.1.0.dist-info/METADATA

@@ -0,0 +1,189 @@
+Metadata-Version: 2.4
+Name: codex-pal
+Version: 0.1.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Software Development
+Classifier: Topic :: Utilities
+License-File: LICENSE
+Summary: Launch Codex CLI through codex-relay for OpenAI-compatible model providers
+Keywords: codex,codex-relay,openai-compatible,llm,cli
+Home-Page: https://github.com/MetaFARS/codex-pal
+Author: MetaFARS
+License-Expression: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/MetaFARS/codex-pal
+Project-URL: Issues, https://github.com/MetaFARS/codex-pal/issues
+Project-URL: Repository, https://github.com/MetaFARS/codex-pal
+
+# codex-pal
+
+`codex-pal` launches Codex CLI through
+[`codex-relay`](https://github.com/MetaFARS/codex-relay) so Codex can use
+OpenAI-compatible providers that do not natively implement the Responses API.
+
+It is intentionally a small launcher:
+
+- starts or reuses a local `codex-relay` sidecar;
+- injects per-invocation Codex config with `-c`, leaving `~/.codex/config.toml` untouched;
+- maps common providers to upstream URLs and API-key environment variables;
+- hands the terminal to `codex`.
+
+## Install
+
+From crates.io:
+
+```bash
+cargo install codex-pal
+```
+
+From PyPI:
+
+```bash
+pipx install codex-pal
+```
+
+`codex-pal` expects `codex` and `codex-relay` to be installed and available on
+`PATH`.
+
+## Usage
+
+`codex-pal` has two interfaces:
+
+- a complete, explicit interface for scripts and debugging;
+- a profile interface for humans.
+
+### Human-friendly profiles
+
+```bash
+export DEEPSEEK_API_KEY=...
+codex-pal deepseek
+
+export DASHSCOPE_API_KEY=...
+codex-pal qwen
+
+export OPENROUTER_API_KEY=...
+codex-pal openrouter
+```
+
+The first run creates a profile under `~/.config/codex-pal/config.toml` when
+the profile name matches a built-in provider. Later runs reuse it.
+
+Configure or modify a profile:
+
+```bash
+codex-pal deepseek config --model deepseek-reasoner --port 4555
+codex-pal deepseek show
+codex-pal profiles
+codex-pal providers
+codex-pal deepseek status
+codex-pal deepseek stop
+codex-pal deepseek restart
+```
+
+Custom profile:
+
+```bash
+export EXAMPLE_API_KEY=...
+codex-pal work-llm config \
+  --provider custom \
+  --upstream https://llm.example.com/v1 \
+  --api-key-env EXAMPLE_API_KEY \
+  --model vendor/model
+codex-pal work-llm
+```
+
+### Complete explicit interface
+
+Use `run` when every setting should be supplied by arguments:
+
+```bash
+codex-pal run \
+  --provider deepseek \
+  --model deepseek-chat \
+  --port 4444 \
+  --approval never \
+  --sandbox workspace-write
+```
+
+Custom one-shot launch:
+
+```bash
+codex-pal run \
+  --provider custom \
+  --upstream https://llm.example.com/v1 \
+  --api-key-env EXAMPLE_API_KEY \
+  --model vendor/model
+```
+
+Useful flags:
+
+```bash
+codex-pal relay status --port 4444
+codex-pal relay stop --port 4444
+codex-pal relay-config --provider openrouter
+codex-pal run --provider deepseek --model deepseek-chat --print-codex-command
+codex-pal run --provider deepseek --model deepseek-chat --ask
+codex-pal run --provider deepseek --model deepseek-chat --no-sandbox
+```
+
+Extra arguments after `--` are appended to the `codex` invocation:
+
+```bash
+codex-pal run --provider deepseek --model deepseek-chat -- --oss
+codex-pal deepseek -- --oss
+```
+
+## Provider Profiles
+
+| Provider | Upstream | API key env |
+| --- | --- | --- |
+| `deepseek` | `https://api.deepseek.com/v1` | `DEEPSEEK_API_KEY` |
+| `kimi`, `moonshot` | `https://api.moonshot.cn/v1` | `MOONSHOT_API_KEY` |
+| `qwen`, `dashscope` | `https://dashscope.aliyuncs.com/compatible-mode/v1` | `DASHSCOPE_API_KEY` |
+| `mistral` | `https://api.mistral.ai/v1` | `MISTRAL_API_KEY` |
+| `groq` | `https://api.groq.com/openai/v1` | `GROQ_API_KEY` |
+| `xai`, `grok` | `https://api.x.ai/v1` | `XAI_API_KEY` |
+| `openrouter` | `https://openrouter.ai/api/v1` | `OPENROUTER_API_KEY` |
+
+## Development
+
+```bash
+cargo test
+cargo fmt --check
+maturin build
+```
+
+## Release
+
+Releases are tag-driven from GitHub Actions.
+
+One-time setup:
+
+1. Create a GitHub environment named `release`.
+2. Add an environment secret named `CARGO_REGISTRY_TOKEN` with a crates.io API token.
+3. On PyPI, create a pending Trusted Publisher for:
+   - project: `codex-pal`
+   - owner: `MetaFARS`
+   - repository: `codex-pal`
+   - workflow: `release.yml`
+   - environment: `release`
+
+Publish:
+
+```bash
+git tag v0.1.0
+git push origin v0.1.0
+```
+
+The release workflow builds all wheels and the sdist, publishes to PyPI via
+Trusted Publishing, publishes the Rust crate to crates.io, and creates a
+GitHub Release with the built artifacts.
+

codex_pal-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+codex_pal-0.1.0.data/scripts/codex-pal.exe,sha256=fqGSEulsq1xhvv1Jm_pBl4ro3Jj6XI6YNrWL6vZiqL4,1118208
+codex_pal-0.1.0.dist-info/METADATA,sha256=CKpaOKaX8k30dupr_XeZdPFW2A2dGv22Aa_NiVsSPmU,5106
+codex_pal-0.1.0.dist-info/WHEEL,sha256=JNKjfk8t_lLPebUae1rF2yydfqwhoTBTQSUGXxfneN4,90
+codex_pal-0.1.0.dist-info/licenses/LICENSE,sha256=GpIWUin7vy-jrVO8aLh_0mlXIt_jGb1BbFqMwKhLDp0,1086
+codex_pal-0.1.0.dist-info/sboms/codex-pal.cyclonedx.json,sha256=UKA8qInvAH0F5HmQnkbjA6pnQ5xFiCh-qxkvczAloPs,46769
+codex_pal-0.1.0.dist-info/RECORD,,

codex_pal-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.14.1)
+Root-Is-Purelib: false
+Tag: py3-none-win32

codex_pal-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 MetaFARS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.