mindwire 0.1.0__tar.gz

mindwire-0.1.0/.gitignore

@@ -0,0 +1,92 @@
+# ---- Node / TypeScript ----
+node_modules/
+dist/
+build/
+out/
+*.tsbuildinfo
+.turbo/
+coverage/
+.eslintcache
+
+# Package manager artifacts (keep ONE lockfile per repo; see below)
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/releases
+next-env.d.ts
+.next/
+
+# ---- Go ----
+# Compiled binaries / build output
+/packages/daemon/dist/
+/packages/daemon/bin/
+/packages/daemon/.dev/
+*.exe
+*.test
+*.out
+# Go workspace file (local, machine-specific)
+go.work
+go.work.sum
+
+# ---- Fumadocs generated content ----
+# The .source cache and the four generated reference trees are rebuilt by `bun run gen:reference`
+# + the fumadocs-mdx step. Ignore ONLY the generated artifacts so the hand-authored pages in the same
+# reference/ folder (meta.json, agents/meta.json, agents/{claude,codex}.mdx) stay tracked.
+/apps/web/.source/
+/apps/web/content/docs/reference/rest/
+/apps/web/content/docs/reference/sdk-ts/
+/apps/web/content/docs/reference/sdk-go/
+/apps/web/content/docs/reference/agents/index.mdx
+
+# ---- Daemon runtime state ----
+agent-state.json
+.mindwire-state.json
+*.log
+
+# ---- Prebuilt daemon packages + local dev binary (from packages/sdk/scripts/build-daemon.mjs) ----
+/packages/sdk/npm/
+/packages/sdk/bin/
+
+# ---- Env / secrets ----
+.env
+.env.*
+!.env.example
+.mindwire-dev-token
+
+# ---- OS ----
+.DS_Store
+Thumbs.db
+desktop.ini
+
+# ---- Editors / IDEs ----
+.idea/
+.vscode/*
+!.vscode/extensions.json
+!.vscode/settings.json.example
+*.swp
+*~
+
+# ---- Logs / temp ----
+*.tmp
+tmp/
+.cache/
+
+# Preview/console local state — Better Auth SQLite (real accounts + password hashes). Never commit.
+apps/console/.data/
+packages/daemon/catalog.json
+
+# Apple app captures and local tooling output.
+apps/apple/artifacts/app-store/
+apps/apple/artifacts/Mindwire-App-Store.zip
+apps/apple/artifacts/launch-film-*/
+**/__pycache__/
+
+# Python SDK development and packaging.
+.venv/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+*.egg-info/
+
+# Local push service account and migration exports; never build or commit.
+.secrets/

mindwire-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2026 The mindwire authors
+
+   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.

mindwire-0.1.0/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: mindwire
+Version: 0.1.0
+Summary: Python SDK for building products with MindWire's shared coding-agent runtime.
+Project-URL: Homepage, https://mindwire.sh
+Project-URL: Documentation, https://github.com/oblien/mindwire/tree/main/packages/python
+Project-URL: Repository, https://github.com/oblien/mindwire
+Project-URL: Issues, https://github.com/oblien/mindwire/issues
+Author: Oblien
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agents,claude-code,codex,mindwire,sdk
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+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: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx<1,>=0.28.1
+Provides-Extra: dev
+Requires-Dist: build<2,>=1.2; extra == 'dev'
+Requires-Dist: mypy<2,>=1.18; extra == 'dev'
+Requires-Dist: pytest<10,>=8; extra == 'dev'
+Requires-Dist: ruff<1,>=0.14; extra == 'dev'
+Requires-Dist: twine<8,>=7; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# MindWire for Python
+
+Build products with the same agent runtime used by MindWire's TypeScript and Go
+SDKs. This initial Python SDK connects to an **existing local or remote runtime**
+over HTTP and server-sent events. It includes synchronous and asynchronous clients,
+turns, streaming, run snapshots, cancellation, interaction responses and conversation
+handoffs. The low-level `request()` method exposes the rest of the shared API.
+
+Requires Python 3.10 or newer. Licensed under Apache-2.0.
+
+## Install
+
+Once the first release is published:
+
+```sh
+pip install mindwire
+```
+
+For development from this repository:
+
+```sh
+python -m pip install -e './packages/python[dev]'
+```
+
+## Connect and run
+
+Start or connect to a [MindWire runtime](https://mindwire.sh/docs/guides/quickstart)
+and authenticate its agent. Set `MINDWIRE_BASE_URL` and `MINDWIRE_TOKEN` in your
+application environment. A local runtime usually listens on `http://127.0.0.1:8790`;
+use its configured bearer token. Use HTTPS for connections across the network.
+
+```python
+import os
+from mindwire import Mindwire
+
+with Mindwire(
+    base_url=os.environ["MINDWIRE_BASE_URL"],
+    token=os.environ["MINDWIRE_TOKEN"],
+    agent="codex",
+) as mw:
+    run = mw.turn(
+        chat_id="launch",
+        message="Read brief.md and write a launch plan.",
+        cwd="/workspace/product",  # A directory on the runtime's computer.
+    )
+    for event in run:
+        if event["type"] == "text":
+            print(event.get("text", ""), end="", flush=True)
+    outcome = run.wait()
+    print(outcome["run"]["status"])
+```
+
+`run.wait()` consumes the stream and checks the final run record. Calling it after
+iteration replays the stream internally to collect its result. It raises
+`RunFailedError` for errors, cancellation, or a stream ending before a terminal
+status. Pass `throw_on_error=False` to inspect that outcome yourself.
+
+The Python SDK does not install, launch or provision the runtime in this release.
+Local, Docker, SSH and cloud environments work when you provide a reachable
+runtime URL and token. Harness authentication and capability support are owned by
+the runtime; the SDK does not sign in to an agent on your behalf.
+
+## Async applications
+
+```python
+import asyncio
+import os
+from mindwire import AsyncMindwire
+
+async def main():
+    async with AsyncMindwire(
+        base_url=os.environ["MINDWIRE_BASE_URL"],
+        token=os.environ["MINDWIRE_TOKEN"],
+        agent="claude-code",
+    ) as mw:
+        run = await mw.turn(chat_id="research", message="Summarize this project.")
+        async for event in run:
+            if event["type"] == "text":
+                print(event.get("text", ""), end="", flush=True)
+        await run.wait()
+
+asyncio.run(main())
+```
+
+## Runs and streams
+
+- `mw.turn(...)` starts a turn. Supply `request_id` and retain it when retrying an
+  unacknowledged creation request on runtimes supporting `turnRequestVersion`.
+- `mw.run(run_id)` and `mw.latest_run(chat_id)` reattach to existing work.
+- `run.snapshot()` reads current output and its cursor;
+  `run.stream(after=snapshot["sequence"])` follows newer events on runtimes that
+  advertise cursor support.
+- `run.cancel()` stops execution. Closing a client or event stream only closes
+  observation; the runtime continues admitted work while it remains running.
+- `run.respond({...})` answers a supported interaction using the shared API payload.
+- `mw.turn(..., mode="resolve", resolve={"maxIterations": 5})` runs bounded
+  continuation when the selected harness supports it.
+
+To stop reading early, explicitly close the stream using `contextlib.closing`
+(sync) or `contextlib.aclosing` (async). For example:
+
+```python
+from contextlib import closing
+
+with closing(run.stream()) as stream:
+    for event in stream:
+        if event["type"] == "interaction":
+            break
+```
+
+Unary requests have a configurable timeout (`timeout=120.0`, in seconds). SSE
+streams have no read timeout so an agent can continue working through idle periods.
+The client does not automatically retry turns or reconnect interrupted streams.
+
+## Shared API and handoffs
+
+`mw.request(method, path, json=..., params=...)` returns the parsed response body.
+It accepts runtime API paths, not arbitrary URLs. All payloads, response objects,
+turn `options` and event fields retain the shared API's **camelCase** field names.
+Python method parameters use snake_case.
+
+```python
+bots = mw.request("GET", "/bots")
+config = mw.request("GET", "/config", params={"agent": "codex"})
+preview = mw.preview_handoff("launch")
+handoff = mw.handoff("launch", {
+    "newChatId": "launch-review",
+    "requestId": "launch-review-001",
+    "targetAgentId": "saved-claude-profile-id",
+    "task": "Review the plan and identify missing steps.",
+})
+review_run = mw.run(handoff["run"]["id"])
+```
+
+Handoffs require a compatible runtime, an eligible source conversation and a saved
+destination agent profile. Use `preview` to inspect the context before submission;
+see the [handoff guide](https://mindwire.sh/docs/guides/handoffs) for field semantics.
+
+`APIError` preserves `status`, `method`, `path` and the server's `body`.
+`ConnectionError` and `TimeoutError` identify transport failures. All inherit
+from `MindwireError`. Errors do not expose the configured bearer token.
+
+## Development and releases
+
+```sh
+cd packages/python
+python -m pytest
+ruff check src tests
+mypy src
+python -m build
+python -m twine check --strict dist/*
+```
+
+The Python package has its own version, initially `0.1.0`. The runtime and
+TypeScript package keep their existing release cycle. See [RELEASING.md](RELEASING.md)
+for PyPI setup and publishing.

mindwire-0.1.0/README.md

@@ -0,0 +1,156 @@
+# MindWire for Python
+
+Build products with the same agent runtime used by MindWire's TypeScript and Go
+SDKs. This initial Python SDK connects to an **existing local or remote runtime**
+over HTTP and server-sent events. It includes synchronous and asynchronous clients,
+turns, streaming, run snapshots, cancellation, interaction responses and conversation
+handoffs. The low-level `request()` method exposes the rest of the shared API.
+
+Requires Python 3.10 or newer. Licensed under Apache-2.0.
+
+## Install
+
+Once the first release is published:
+
+```sh
+pip install mindwire
+```
+
+For development from this repository:
+
+```sh
+python -m pip install -e './packages/python[dev]'
+```
+
+## Connect and run
+
+Start or connect to a [MindWire runtime](https://mindwire.sh/docs/guides/quickstart)
+and authenticate its agent. Set `MINDWIRE_BASE_URL` and `MINDWIRE_TOKEN` in your
+application environment. A local runtime usually listens on `http://127.0.0.1:8790`;
+use its configured bearer token. Use HTTPS for connections across the network.
+
+```python
+import os
+from mindwire import Mindwire
+
+with Mindwire(
+    base_url=os.environ["MINDWIRE_BASE_URL"],
+    token=os.environ["MINDWIRE_TOKEN"],
+    agent="codex",
+) as mw:
+    run = mw.turn(
+        chat_id="launch",
+        message="Read brief.md and write a launch plan.",
+        cwd="/workspace/product",  # A directory on the runtime's computer.
+    )
+    for event in run:
+        if event["type"] == "text":
+            print(event.get("text", ""), end="", flush=True)
+    outcome = run.wait()
+    print(outcome["run"]["status"])
+```
+
+`run.wait()` consumes the stream and checks the final run record. Calling it after
+iteration replays the stream internally to collect its result. It raises
+`RunFailedError` for errors, cancellation, or a stream ending before a terminal
+status. Pass `throw_on_error=False` to inspect that outcome yourself.
+
+The Python SDK does not install, launch or provision the runtime in this release.
+Local, Docker, SSH and cloud environments work when you provide a reachable
+runtime URL and token. Harness authentication and capability support are owned by
+the runtime; the SDK does not sign in to an agent on your behalf.
+
+## Async applications
+
+```python
+import asyncio
+import os
+from mindwire import AsyncMindwire
+
+async def main():
+    async with AsyncMindwire(
+        base_url=os.environ["MINDWIRE_BASE_URL"],
+        token=os.environ["MINDWIRE_TOKEN"],
+        agent="claude-code",
+    ) as mw:
+        run = await mw.turn(chat_id="research", message="Summarize this project.")
+        async for event in run:
+            if event["type"] == "text":
+                print(event.get("text", ""), end="", flush=True)
+        await run.wait()
+
+asyncio.run(main())
+```
+
+## Runs and streams
+
+- `mw.turn(...)` starts a turn. Supply `request_id` and retain it when retrying an
+  unacknowledged creation request on runtimes supporting `turnRequestVersion`.
+- `mw.run(run_id)` and `mw.latest_run(chat_id)` reattach to existing work.
+- `run.snapshot()` reads current output and its cursor;
+  `run.stream(after=snapshot["sequence"])` follows newer events on runtimes that
+  advertise cursor support.
+- `run.cancel()` stops execution. Closing a client or event stream only closes
+  observation; the runtime continues admitted work while it remains running.
+- `run.respond({...})` answers a supported interaction using the shared API payload.
+- `mw.turn(..., mode="resolve", resolve={"maxIterations": 5})` runs bounded
+  continuation when the selected harness supports it.
+
+To stop reading early, explicitly close the stream using `contextlib.closing`
+(sync) or `contextlib.aclosing` (async). For example:
+
+```python
+from contextlib import closing
+
+with closing(run.stream()) as stream:
+    for event in stream:
+        if event["type"] == "interaction":
+            break
+```
+
+Unary requests have a configurable timeout (`timeout=120.0`, in seconds). SSE
+streams have no read timeout so an agent can continue working through idle periods.
+The client does not automatically retry turns or reconnect interrupted streams.
+
+## Shared API and handoffs
+
+`mw.request(method, path, json=..., params=...)` returns the parsed response body.
+It accepts runtime API paths, not arbitrary URLs. All payloads, response objects,
+turn `options` and event fields retain the shared API's **camelCase** field names.
+Python method parameters use snake_case.
+
+```python
+bots = mw.request("GET", "/bots")
+config = mw.request("GET", "/config", params={"agent": "codex"})
+preview = mw.preview_handoff("launch")
+handoff = mw.handoff("launch", {
+    "newChatId": "launch-review",
+    "requestId": "launch-review-001",
+    "targetAgentId": "saved-claude-profile-id",
+    "task": "Review the plan and identify missing steps.",
+})
+review_run = mw.run(handoff["run"]["id"])
+```
+
+Handoffs require a compatible runtime, an eligible source conversation and a saved
+destination agent profile. Use `preview` to inspect the context before submission;
+see the [handoff guide](https://mindwire.sh/docs/guides/handoffs) for field semantics.
+
+`APIError` preserves `status`, `method`, `path` and the server's `body`.
+`ConnectionError` and `TimeoutError` identify transport failures. All inherit
+from `MindwireError`. Errors do not expose the configured bearer token.
+
+## Development and releases
+
+```sh
+cd packages/python
+python -m pytest
+ruff check src tests
+mypy src
+python -m build
+python -m twine check --strict dist/*
+```
+
+The Python package has its own version, initially `0.1.0`. The runtime and
+TypeScript package keep their existing release cycle. See [RELEASING.md](RELEASING.md)
+for PyPI setup and publishing.

mindwire-0.1.0/RELEASING.md

@@ -0,0 +1,52 @@
+# Publish the Python SDK
+
+The distribution is named `mindwire`, with import namespace `mindwire`. A name
+becomes claimed only after the first successful PyPI upload. Pending publishers
+do not reserve names; check availability before the first release.
+
+## One-time PyPI account setup
+
+1. [Sign in or register](https://pypi.org/account/login/) on PyPI, verify your email
+   and complete its two-factor authentication setup.
+2. Open [Publishing](https://pypi.org/manage/account/publishing/) and add a pending
+   **GitHub** publisher with these exact values:
+
+   | Field | Value |
+   | --- | --- |
+   | PyPI project name | `mindwire` |
+   | Owner | `oblien` |
+   | Repository name | `mindwire` |
+   | Workflow name | `publish-python.yml` |
+   | Environment name | `pypi` |
+
+3. The matching GitHub environment is `pypi`. Configure its deployment permissions
+   under the [repository environments](https://github.com/oblien/mindwire/settings/environments).
+
+Publishing uses GitHub's OIDC identity, so no PyPI password or persistent API token
+is needed in GitHub secrets or source files. The first upload creates the PyPI
+project in the account that configured the pending publisher.
+
+## Publish
+
+1. Update `__version__` in `src/mindwire/_version.py`. Package metadata, the public
+   version and the User-Agent all use that value.
+2. Commit and push the reviewed SDK changes to `main`.
+3. Open [Python SDK workflow](https://github.com/oblien/mindwire/actions/workflows/publish-python.yml).
+   Choose **Run workflow**, select `main`, and enable **Publish to PyPI**.
+
+The workflow tests Python 3.10 and 3.14, builds a source archive and universal
+Python wheel, validates their metadata, installs the built wheel and source
+archive in clean environments, and tests against a fresh Go runtime. Only the
+publish job has OIDC permission. It uploads the already-tested artifacts to PyPI
+and then checks that a clean `pip install mindwire==VERSION` succeeds from PyPI.
+
+Ordinary pushes and pull requests run checks without publishing. Manual runs with
+the publish option disabled also only validate. Publication is restricted to the
+repository's `main` branch. Bump the Python version for subsequent releases; PyPI
+does not allow replacing previously uploaded distributions.
+
+```sh
+gh workflow run publish-python.yml --ref main -f publish=true
+```
+
+See [PyPI's Trusted Publishing documentation](https://docs.pypi.org/trusted-publishers/creating-a-project-through-oidc/).