courier-encode 0.1.2__tar.gz → 0.1.4__tar.gz

courier_encode-0.1.4/.idea/workspace.xml

@@ -0,0 +1,105 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="AutoImportSettings">
+    <option name="autoReloadType" value="ALL" />
+  </component>
+  <component name="ChangeListManager">
+    <list default="true" id="9259bfb5-884c-4336-83fd-f640b45e88c5" name="Changes" comment="">
+      <change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/docs.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/docs/cookbook.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/cookbook.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/docs/intercept.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/intercept.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/docs/sessions.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/sessions.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/docs/tools.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/tools.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/encode/events.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/encode/events.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/encode/relay.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/encode/relay.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/encode/session.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/encode/session.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/encode/tools.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/encode/tools.py" afterDir="false" />
+    </list>
+    <option name="SHOW_DIALOG" value="false" />
+    <option name="HIGHLIGHT_CONFLICTS" value="true" />
+    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
+    <option name="LAST_RESOLUTION" value="IGNORE" />
+  </component>
+  <component name="EmbeddingIndexingInfo">
+    <option name="cachedIndexableFilesCount" value="77" />
+    <option name="fileBasedEmbeddingIndicesEnabled" value="true" />
+  </component>
+  <component name="Git.Settings">
+    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
+  </component>
+  <component name="McpProjectServerCommands">
+    <commands />
+    <urls />
+  </component>
+  <component name="ProjectColorInfo">{
+  &quot;associatedIndex&quot;: 8,
+  &quot;fromUser&quot;: false
+}</component>
+  <component name="ProjectId" id="3DRfPMmybWPzhvemSx3K8mYqPeH" />
+  <component name="ProjectViewState">
+    <option name="hideEmptyMiddlePackages" value="true" />
+    <option name="showLibraryContents" value="true" />
+  </component>
+  <component name="PropertiesComponent">{
+  &quot;keyToString&quot;: {
+    &quot;ModuleVcsDetector.initialDetectionPerformed&quot;: &quot;true&quot;,
+    &quot;RunOnceActivity.MCP Project settings loaded&quot;: &quot;true&quot;,
+    &quot;RunOnceActivity.ShowReadmeOnStart&quot;: &quot;true&quot;,
+    &quot;RunOnceActivity.TerminalTabsStorage.copyFrom.TerminalArrangementManager.252&quot;: &quot;true&quot;,
+    &quot;RunOnceActivity.git.unshallow&quot;: &quot;true&quot;,
+    &quot;RunOnceActivity.typescript.service.memoryLimit.init&quot;: &quot;true&quot;,
+    &quot;codeWithMe.voiceChat.enabledByDefault&quot;: &quot;false&quot;,
+    &quot;com.intellij.ml.llm.matterhorn.ej.ui.settings.DefaultModelSelectionForGA.v1&quot;: &quot;true&quot;,
+    &quot;git-widget-placeholder&quot;: &quot;main&quot;,
+    &quot;junie.onboarding.icon.badge.shown&quot;: &quot;true&quot;,
+    &quot;last_opened_file_path&quot;: &quot;/Users/jacksonoaks/Documents/business/recursion_ai/encode&quot;,
+    &quot;node.js.detected.package.eslint&quot;: &quot;true&quot;,
+    &quot;node.js.detected.package.tslint&quot;: &quot;true&quot;,
+    &quot;node.js.selected.package.eslint&quot;: &quot;(autodetect)&quot;,
+    &quot;node.js.selected.package.tslint&quot;: &quot;(autodetect)&quot;,
+    &quot;nodejs_package_manager_path&quot;: &quot;npm&quot;,
+    &quot;to.speed.mode.migration.done&quot;: &quot;true&quot;,
+    &quot;vue.rearranger.settings.migration&quot;: &quot;true&quot;
+  }
+}</component>
+  <component name="SharedIndexes">
+    <attachedChunks>
+      <set>
+        <option value="bundled-js-predefined-d6986cc7102b-3bd3a6803838-JavaScript-PY-261.22158.340" />
+        <option value="bundled-python-sdk-b63d5a1f7c97-b61e75351b1f-com.jetbrains.pycharm.pro.sharedIndexes.bundled-PY-261.22158.340" />
+      </set>
+    </attachedChunks>
+  </component>
+  <component name="TaskManager">
+    <task active="true" id="Default" summary="Default task">
+      <changelist id="9259bfb5-884c-4336-83fd-f640b45e88c5" name="Changes" comment="" />
+      <created>1778249777914</created>
+      <option name="number" value="Default" />
+      <option name="presentableId" value="Default" />
+      <updated>1778249777914</updated>
+      <workItem from="1778249778942" duration="11940000" />
+      <workItem from="1778400115032" duration="568000" />
+      <workItem from="1778401424863" duration="35000" />
+      <workItem from="1778423372046" duration="273000" />
+      <workItem from="1778423984110" duration="32000" />
+      <workItem from="1778512211978" duration="598000" />
+      <workItem from="1778554267806" duration="2737000" />
+      <workItem from="1778562018820" duration="121000" />
+      <workItem from="1778562226220" duration="194000" />
+      <workItem from="1778562580231" duration="10000" />
+      <workItem from="1778562812770" duration="145000" />
+      <workItem from="1778563167441" duration="597000" />
+      <workItem from="1778563885595" duration="136000" />
+      <workItem from="1778564171039" duration="6000" />
+      <workItem from="1778565065245" duration="21000" />
+      <workItem from="1778566926702" duration="15000" />
+      <workItem from="1778567092312" duration="17000" />
+      <workItem from="1778617494707" duration="2069000" />
+    </task>
+    <servers />
+  </component>
+  <component name="TypeScriptGeneratedFilesManager">
+    <option name="version" value="3" />
+  </component>
+</project>

courier_encode-0.1.4/PKG-INFO

@@ -0,0 +1,409 @@
+Metadata-Version: 2.4
+Name: courier-encode
+Version: 0.1.4
+Summary: Python SDK for OpenAI-compatible inference endpoints (Courier and friends) with auto tool-call loops, structured outputs, and Whisper.
+Project-URL: Homepage, https://getcourier.ai
+Project-URL: Documentation, https://getcourier.ai/docs
+Project-URL: Repository, https://github.com/recursion-ai/encode
+Author: Recursion AI
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright [yyyy] [name of copyright owner]
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+License-File: LICENSE
+Keywords: agents,courier,llm,openai,sdk,tool-calling,whisper
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27
+Requires-Dist: pexpect>=4.9
+Requires-Dist: pydantic>=2.7
+Requires-Dist: python-dotenv>=1.0
+Requires-Dist: typing-extensions>=4.10
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == 'dev'
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# encode
+
+> One Python entry-point for any OpenAI-compatible LLM, with an auto-agent loop, durable sessions, and the brain/hands/session primitives from Anthropic's [Managed Agents](https://www.anthropic.com/engineering/managed-agents) post baked in.
+
+```python
+import encode
+
+def get_weather(city: str) -> dict:
+    """Get weather by city."""
+    return {"city": city, "temp_f": 72}
+
+out = encode.relay(
+    model="gpt-4o-mini",
+    messages=[{"role": "user", "content": "Weather in Denver?"}],
+    tools=[get_weather],
+).response
+
+print(out.content)   # "It's 72°F in Denver."
+```
+
+That's the whole "hello world." The model called `get_weather`, encode dispatched it, fed the result back, and returned the final answer.
+
+## What encode is
+
+A Python SDK for any OpenAI-compatible inference endpoint — Courier, OpenAI, vLLM, LM Studio, Ollama, Together, Groq, and more. One `relay()` function spans `/v1/chat/completions` and `/v1/responses`. Pass tools and it runs the loop to completion. Pass a `Session` and the run is durable. Pass a `Terminal` and your agent has a shell.
+
+## Why encode
+
+- **Auto tool loop.** Drop a Python function in `tools=`; encode introspects the signature, builds the schema, runs the loop, and feeds results back. No decorators, no manual loop scaffolding.
+- **Both endpoints, one API.** `relay()` auto-routes between `/v1/chat/completions` and `/v1/responses` — same handle, same tool loop, same intercept, same streaming consumer.
+- **Sessions as Pydantic event logs.** Append-only, BYO storage. `session.model_dump()` to your DB; `Session.model_validate()` to resume — across processes, machines, or days.
+- **Mid-loop context engineering.** Intercept callbacks can `append`, `insert`, `replace`, `edit_last_tool_result`, or `compact` the conversation that goes into the *next* iteration. Real context engineering in the harness, not just observation.
+- **`ToolExecutor` seam.** Swap dispatch (local → remote → MCP → sub-agent) without touching the harness.
+- **Terminal as a first-class primitive.** Persistent bash subprocess that retains cwd/env/venvs across calls. Wrap one in a closure and your agent has a shell.
+- **Full sync/async parity.** Every helper has a `*_async` twin; async tool callables and async intercept callbacks just work.
+- **Streaming with the loop intact.** Stream tokens *and* tool calls in real time across both endpoints.
+
+## 60-second tour
+
+```python
+import json
+import encode
+
+# 1. Plain chat
+encode.relay(
+    model="gpt-4o-mini",
+    messages=[{"role": "user", "content": "hi"}],
+).response.content
+
+# 2. With a tool — auto-loop runs until the model stops calling tools
+def lookup(q: str) -> dict:
+    """Look something up."""
+    return {"q": q, "answer": "42"}
+
+encode.relay(
+    model="gpt-4o-mini",
+    messages=[{"role": "user", "content": "What's the meaning of life?"}],
+    tools=[lookup],
+).response.content
+
+# 3. With a Session — durable, resumable, BYO persistence
+session = encode.Session.open()
+encode.relay(
+    model="gpt-4o-mini",
+    messages=[{"role": "user", "content": "remember: my name is Alex"}],
+    session=session,
+).response
+
+# Persist anywhere — file, Postgres, Redis, S3...
+open("/tmp/agent.json", "w").write(json.dumps(session.model_dump(), default=str))
+
+# Resume anywhere
+resumed = encode.Session.model_validate(json.loads(open("/tmp/agent.json").read()))
+encode.relay(
+    model="gpt-4o-mini",
+    messages=[{"role": "user", "content": "what's my name?"}],
+    session=resumed,
+).response.content   # → "Alex"
+```
+
+## Install
+
+```bash
+pip install encode
+```
+
+Python 3.10+. Configure with a `.env` (auto-loaded) or kwargs:
+
+```bash
+# .env
+ENCODE_API_KEY=sk-your-key
+ENCODE_BASE_URL=https://api.openai.com/v1
+```
+
+`OPENAI_API_KEY` / `OPENAI_BASE_URL` are also picked up if `ENCODE_*` aren't set.
+
+## What you can build
+
+**Multi-turn chat with stateful `Messages`** — pass a `Messages` instance and it grows itself across `relay()` calls.
+
+```python
+m = encode.Messages().system("Be brief.")
+m.user("name three colors")
+encode.relay(model="m", messages=m).response   # m now has the assistant turn too
+```
+
+**An agent that stops when it submits a final answer.**
+
+```python
+def watcher(event):
+    if any(tc.name == "submit_final" for tc in event.tool_calls):
+        event.stop()
+
+encode.relay(..., tools=[search, submit_final]).intercept(watcher).response
+```
+
+**Mid-loop context compaction** — trim, summarize, redact, or rewrite history without subclassing anything.
+
+```python
+def trim(event):
+    event.edit_last_tool_result(lambda c: c[:1000])
+
+encode.relay(..., tools=[noisy_tool], on_intercept=trim).response
+```
+
+**Auto tool discovery** — the model calls a `list_tools` bootstrap, an intercept registers the discovered tools on the session, the next iteration uses them.
+
+```python
+session = encode.Session.open(tools=[list_tools])
+
+def discover(event):
+    for tc in event.tool_calls:
+        if tc.name == "list_tools":
+            for spec in tc.result or []:
+                event.register_tool(IMPLS[spec["function"]["name"]])
+
+encode.relay(model="m", messages=[...], session=session,
+             tools=session.tools, on_intercept=discover).response
+```
+
+**A bash sandbox tool.**
+
+```python
+class BashSandbox:
+    def __init__(self):
+        self._term = None
+    def as_tool(self):
+        sandbox = self
+        def bash(command: str) -> dict:
+            """Run a bash command in a persistent shell."""
+            self._term = self._term or encode.Terminal()
+            r = self._term.run(command, timeout=10.0)
+            return {"output": r.output, "exit_code": r.exit_code, "cwd": r.cwd}
+        return bash
+
+encode.relay(..., tools=[BashSandbox().as_tool()]).response
+```
+
+## Docs
+
+→ [docs.md](./docs.md) is the entry point — concept map + a link grid into focused topic pages:
+
+[quickstart](./docs/quickstart.md) · [concepts](./docs/concepts.md) · [relay()](./docs/relay.md) · [messages](./docs/messages.md) · [tools](./docs/tools.md) · [intercept](./docs/intercept.md) · [sessions](./docs/sessions.md) · [executors](./docs/executors.md) · [terminal](./docs/terminal.md) · [streaming](./docs/streaming.md) · [structured output](./docs/structured-output.md) · [whisper](./docs/whisper.md) · [async](./docs/async.md) · [errors](./docs/errors.md) · [cookbook](./docs/cookbook.md)
+
+## Status & compatibility
+
+- Python 3.10+
+- macOS / Linux for `Terminal` (pexpect-backed)
+- OpenAI-compatible endpoints: OpenAI, [Courier](https://getcourier.ai), vLLM, LM Studio, Ollama, Together, Groq, and others
+
+## License
+
+MIT