doc: optimize pyfluss description in pypi#439
Merged
Conversation
luoyuxia
force-pushed
the
optimize-python-doc
branch
from
93ad787 to
086c9b7
Compare
Contributor
Author
|
@leekeiabstraction Could you please help me review this |
leekeiabstraction
approved these changes
Mar 9, 2026
leekeiabstraction
left a comment
leekeiabstraction
left a comment
Contributor
There was a problem hiding this comment.
TY for the PR. Approved
There was a problem hiding this comment.
Pull request overview
This PR simplifies the PyPI description for the pyfluss package by replacing the auto-generated README (assembled from website docs) with a short, static PYPI_README.md that links to the documentation site. It also updates the project homepage URL to point to the client-specific documentation.
Changes:
- Replaced
generate_readme.pyandGENERATED_README.mdwith a concise staticPYPI_README.mdthat links to the documentation site and community page. - Updated
pyproject.tomlto reference the new README, use a clearer project description ("Python client" instead of "Python Binding"), and point the homepage toclients.fluss.apache.org. - Removed all related build/CI infrastructure: the
generate-python-readmejust recipe, the CI "Generate Python README" steps, and the.gitignoreentry for the old generated file.
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
bindings/python/PYPI_README.md |
New concise static README for PyPI with links to docs and community |
bindings/python/pyproject.toml |
Updated description, readme path, and homepage URL |
bindings/python/generate_readme.py |
Deleted: no longer needed with static README |
bindings/python/GENERATED_README.md |
Deleted: replaced by PYPI_README.md |
justfile |
Removed generate-python-readme recipe |
.gitignore |
Removed GENERATED_README.md ignore entry |
.github/workflows/release_python.yml |
Removed README generation steps from sdist and wheels jobs |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Purpose
Linked issue: close #410
Brief change log
Tests
API and Format
Documentation