Skip to content

[SPARK-40993][SPARK-41705][CONNECT] Move Spark Connect documentation and script to dev/ and Python documentation#39338

Closed
HyukjinKwon wants to merge 6 commits intoapache:masterfrom
HyukjinKwon:SPARK-41705
Closed

[SPARK-40993][SPARK-41705][CONNECT] Move Spark Connect documentation and script to dev/ and Python documentation#39338
HyukjinKwon wants to merge 6 commits intoapache:masterfrom
HyukjinKwon:SPARK-41705

Conversation

@HyukjinKwon
Copy link
Member

What changes were proposed in this pull request?

This PR takes over #39211 and #38477 that proposes:

  • Move connector/connect/dev/generate_protos.shdev/generate_protos.sh to be consistent with other places
  • Move Python-specific development guides into python/docs/source/development/testing.rst

Why are the changes needed?

To keep the project structure and documentation consistent.

Does this PR introduce any user-facing change?

Python-specific development guides for Spark Connect will be added in https://spark.apache.org/docs/latest/api/python/development/testing.html.

How was this patch tested?

I manually tested:

./dev/generate_protos.sh
./dev/check-codegen-python.py

I also manually verified the Python documentation.

tedyu and others added 3 commits January 2, 2023 11:42
(cherry picked from commit 63ea058)
Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>
…ython/docs/development/testing.rst.

(cherry picked from commit e99128f)
Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>

### Generate proto generated files for the Python client
1. Install `buf version 1.11.0`: https://docs.buf.build/installation
2. Run `pip install grpcio==1.48.1 protobuf==3.19.5 mypy-protobuf==3.3.0 googleapis-common-protos==1.56.4 grpcio-status==1.48.1`
Copy link
Member Author

Choose a reason for hiding this comment

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

## Development Topics

### Generate proto generated files for the Python client
1. Install `buf version 1.11.0`: https://docs.buf.build/installation
Copy link
Member Author

Choose a reason for hiding this comment

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

Moved to Environment Setup

for compilation steps, please refer to [protobuf](https://github.com/protocolbuffers/protobuf) and [grpc-java](https://github.com/grpc/grpc-java).


### Run Spark Shell
Copy link
Member Author

Choose a reason for hiding this comment

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

Move to python/docs/source/development/testing.rst

@HyukjinKwon
Copy link
Member Author

@grundprinzip
Copy link
Contributor

Maybe at least prefix the scripts with connect so that it's clearer where they belong to and not just a random code dump?

@HyukjinKwon
Copy link
Member Author

SGTM. let me rename them

@github-actions github-actions bot added the INFRA label Jan 2, 2023
@HyukjinKwon
Copy link
Member Author

Merged to master.

@HyukjinKwon HyukjinKwon deleted the SPARK-41705 branch January 15, 2024 00:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants