Prajwal-banakar opened a new pull request, #2461:
URL: https://github.com/apache/fluss/pull/2461
<!--
*Thank you very much for contributing to Fluss - we are happy that you want
to help us improve Fluss. To help the community review your contribution in the
best possible way, please go through the checklist below, which will get the
contribution into a shape in which it can be best reviewed.*
## Contribution Checklist
- Make sure that the pull request corresponds to a [GitHub
issue](https://github.com/apache/fluss/issues). Exceptions are made for typos
in JavaDoc or documentation files, which need no issue.
- Name the pull request in the format "[component] Title of the pull
request", where *[component]* should be replaced by the name of the component
being changed. Typically, this corresponds to the component label assigned to
the issue (e.g., [kv], [log], [client], [flink]). Skip *[component]* if you are
unsure about which is the best component.
- Fill out the template below to describe the changes contributed by the
pull request. That will give reviewers the context they need to do the review.
- Make sure that the change passes the automated tests, i.e., `mvn clean
verify` passes.
- Each pull request should address only one issue, not mix up code from
multiple issues.
**(The sections below can be removed for hotfixes or typos)**
-->
### Purpose
<!-- Linking this pull request to the issue -->
Linked issue: close #2447
<!-- What is the purpose of the change -->
The purpose of this change is to add comprehensive documentation for the
Fluss Python Client. This ensures that Python users have a dedicated guide that
mirrors the structure of the existing Java Client documentation while
highlighting Python-specific features like PyArrow and Pandas integration.
### Brief change log
<!-- Please describe the changes made in this pull request and explain how
they address the issue -->
This pull request introduces the following changes:
New Documentation File: Created website/docs/apis/python-client.md which
includes sections for Installation, Initialization, Admin API, and Table API.
Code Examples: Added asynchronous Python code snippets demonstrating how to
connect to a cluster, manage databases/tables, and perform high-performance
data writing and scanning.
Ecosystem Integration: Documented the native support for PyArrow Tables and
Pandas DataFrames, providing users with idiomatic ways to handle data in Python.
Sidebar Alignment: Set the sidebar_position to 2 to ensure the Python Client
appears immediately after the Java Client in the API documentation hierarchy.
Build Consistency: Updated website/package-lock.json to reflect the
environment-specific dependency tree used during local verification of the
documentation site.
### Tests
<!-- List UT and IT cases to verify this change -->
Manual Verification: The documentation was built and verified locally using
the Docusaurus development server (npm run start).
Visual Check: Confirmed that all code blocks render correctly, syntax
highlighting is active, and the sidebar navigation is correctly ordered.
Before
<img width="1920" height="1080" alt="Screenshot 2026-01-23 224516"
src="https://github.com/user-attachments/assets/bd0f003a-2b2f-40c5-b4a7-2a09e55217b5";
/>
After changes
<img width="1920" height="1080" alt="Screenshot 2026-01-23 224437"
src="https://github.com/user-attachments/assets/7094b342-e39a-4b3e-a972-e0ada2b96427";
/>
### API and Format
<!-- Does this change affect API or storage format -->
This change does not affect any existing public Java APIs or storage
formats; it is strictly a documentation addition for the Python Client.
### Documentation
<!-- Does this change introduce a new feature -->
This PR introduces a new documentation page for the Fluss Python Client.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
