fix(python-sdk): Use README.md as single source of truth, fix CI compile

.speakeasy/workflow.yaml

@@ -33,6 +33,9 @@ targets:
         target: python
         source: Outpost API (Python)
         output: ./sdks/outpost-python
+        # Override: Speakeasy generates readme = "README-PYPI.md" but does not emit that file.
+        # We use README.md as the single source of truth; patch pyproject after generation.
+        compileCommand: "python scripts/patch_pyproject_readme.py && poetry build"
         publish:
             pypi:
                 token: $pypi_token

sdks/outpost-python/.gitignore

@@ -9,7 +9,7 @@ __pycache__/
 .python-version
 .DS_Store
 pyrightconfig.json
-# README-PYPI.md is committed as a temporary workaround for Speakeasy compile; overwritten by scripts/prepare_readme.py at publish.
+README-PYPI.md
 .DS_Store
 **/.speakeasy/temp/
 **/.speakeasy/logs/

sdks/outpost-python/pyproject.toml

@@ -4,7 +4,7 @@ name = "outpost_sdk"
 version = "0.5.0"
 description = "Python Client SDK Generated by Speakeasy."
 authors = [{ name = "Speakeasy" },]
-readme = "README-PYPI.md"
+readme = "README.md"
 requires-python = ">=3.9.2"
 dependencies = [
     "httpcore >=1.0.9",

sdks/outpost-python/scripts/patch_pyproject_readme.py

@@ -0,0 +1,42 @@
+"""
+Override Speakeasy-generated pyproject.toml to use README.md as the package readme.
+
+Speakeasy emits readme = "README-PYPI.md" but does not generate that file. We use
+README.md as the single source of truth for the SDK; this script patches pyproject.toml
+after generation so build/test work. At publish time, prepare_readme.py creates
+README-PYPI.md and publish.sh builds with it.
+"""
+import sys
+
+PYPROJECT = "pyproject.toml"
+OLD = 'readme = "README-PYPI.md"'
+NEW = 'readme = "README.md"'
+
+
+def main() -> int:
+    try:
+        with open(PYPROJECT, "r", encoding="utf-8") as f:
+            content = f.read()
+    except OSError as e:
+        print(f"Failed to read {PYPROJECT}: {e}", file=sys.stderr)
+        return 1
+
+    if OLD not in content:
+        if NEW in content:
+            return 0  # Already patched
+        print(f"Neither {OLD!r} nor {NEW!r} found in {PYPROJECT}", file=sys.stderr)
+        return 1
+
+    content = content.replace(OLD, NEW, 1)
+    try:
+        with open(PYPROJECT, "w", encoding="utf-8") as f:
+            f.write(content)
+    except OSError as e:
+        print(f"Failed to write {PYPROJECT}: {e}", file=sys.stderr)
+        return 1
+
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

sdks/outpost-python/scripts/publish.sh

@@ -1,6 +1,10 @@
 #!/usr/bin/env bash
+# README.md is the source of truth. For PyPI we need absolute links, so we
+# generate README-PYPI.md and point pyproject at it only for this build.
 export POETRY_PYPI_TOKEN_PYPI=${PYPI_TOKEN}
 
 poetry run python scripts/prepare_readme.py
-
+# Point pyproject at the link-rewritten readme for the publish build
+sed -i.bak 's/readme = "README.md"/readme = "README-PYPI.md"/' pyproject.toml
 poetry publish --build --skip-existing
+rm -f pyproject.toml.bak