[MINOR][PYTHON][DOCS] Clarify PySpark installation options#56822
Open
Israelobuk wants to merge 1 commit into
Open
[MINOR][PYTHON][DOCS] Clarify PySpark installation options#56822Israelobuk wants to merge 1 commit into
Israelobuk wants to merge 1 commit into
Conversation
Comment on lines
+86
to
+92
| .. note:: | ||
|
|
||
| Use ``pyspark`` or ``pyspark[connect]`` for a full PySpark installation. | ||
| Use ``pyspark-connect`` when you want Spark Connect to be the default mode. | ||
| Use ``pyspark-client`` when you only need the pure Python Spark Connect client | ||
| for connecting to a remote Spark server. | ||
|
|
Contributor
There was a problem hiding this comment.
Thanks for this note as clarification.
nit: do you think move this after Python Spark Connect Client section, which is line 116, is more clear?
Author
There was a problem hiding this comment.
Honestly, I agree with that.
Yicong-Huang
approved these changes
Jun 26, 2026
uros-b
approved these changes
Jun 27, 2026
uros-b
left a comment
uros-b
left a comment
Member
There was a problem hiding this comment.
Thank you @Israelobuk and @Yicong-Huang!
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
3 participants
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.
What changes were proposed in this pull request?
This PR adds a short note to the PySpark installation documentation clarifying the difference between pyspark, pyspark[connect], pyspark-connect, and pyspark-client.
Why are the changes needed?
The installation page documents these package options in separate sections, but users may not immediately understand which package to choose. This note gives a concise summary of the intended use case for each option.
Does this PR introduce any user-facing change?
No. This is a documentation-only change and does not change runtime behavior.
How was this patch tested?
Ran:
git diff --check
Was this patch authored or co-authored using generative AI tooling?
No