Skip to content

[MINOR][PYTHON][DOCS] Clarify PySpark installation options #56822

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Israelobuk wants to merge 1 commit into
base: master
Choose a base branch
from
+7 −0
Open

[MINOR][PYTHON][DOCS] Clarify PySpark installation options #56822

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions python/docs/source/getting_started/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,13 @@ Supported values in ``PYSPARK_HADOOP_VERSION`` are:

Note that this installation of PySpark with/without a specific Hadoop version is experimental. It can change or be removed between minor releases.

.. 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.

Comment on lines +86 to +92

@Yicong-Huang Yicong-Huang Jun 26, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

@Israelobuk Israelobuk Jun 26, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly, I agree with that.


Making Spark Connect the default
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down