fix(python-sdk): README-PYPI.md workaround for Speakeasy compile#696
Merged
Conversation
- Add committed README-PYPI.md so pyproject.toml build/compile succeeds in CI - Stop ignoring README-PYPI.md in .gitignore (with comment) - File is overwritten by scripts/prepare_readme.py at publish; PyPI unchanged Co-authored-by: Cursor <cursoragent@cursor.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR addresses a Speakeasy build/compile failure by committing a placeholder README-PYPI.md file that pyproject.toml expects. Previously, this file was gitignored and only generated at publish time by scripts/prepare_readme.py, causing build failures.
Changes:
- Stop ignoring
README-PYPI.mdin.gitignorewith explanatory comment about the temporary workaround - Add committed placeholder
README-PYPI.mdthat references the main README and explains it's overwritten at publish time
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| sdks/outpost-python/.gitignore | Updated to stop ignoring README-PYPI.md with explanatory comment |
| sdks/outpost-python/README-PYPI.md | Added placeholder file to satisfy pyproject.toml during build/compile |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| pyrightconfig.json | ||
| README-PYPI.md | ||
| # README-PYPI.md is committed as a temporary workaround for Speakeasy compile; overwritten by scripts/prepare_readme.py at publish. | ||
| .DS_Store |
There was a problem hiding this comment.
Duplicate entry: .DS_Store is already listed on line 10. This duplicate should be removed.
Suggested change
| .DS_Store |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a committed
README-PYPI.mdin the Python SDK so the Speakeasy build/compile step (and CI) succeeds.pyproject.tomlexpects this file.README-PYPI.md(with a comment that it's a temporary workaround, overwritten at publish).scripts/prepare_readme.pyoverwrites it at publish so PyPI gets the correct long description.Made with Cursor