petern48 commented on code in PR #2393: URL: https://github.com/apache/sedona/pull/2393#discussion_r2427752902
########## docs/setup/compile.md: ########## @@ -106,52 +99,38 @@ wget -P $SPARK_HOME/jars/ https://repo.osgeo.org/repository/release/javax/media/ wget -P $SPARK_HOME/jars/ https://repo.osgeo.org/repository/release/javax/media/jai_imageio/${JAI_IMAGEIO_VERSION}/jai_imageio-${JAI_IMAGEIO_VERSION}.jar ``` -4) Compile the Sedona Scala and Java code with `-Dgeotools` and then copy the ==sedona-spark-shaded-{{ sedona.current_version }}.jar== to ==SPARK_HOME/jars/== folder. +3) Build Sedona Scala/Java jars with GeoTools shaded (from repo root) -``` +```bash +mvn clean install -DskipTests -Dgeotools cp spark-shaded/target/sedona-spark-shaded-*.jar $SPARK_HOME/jars/ ``` -5) Install the following libraries +4) Setup Python development environment -``` -sudo apt-get -y install python3-pip python-dev libgeos-dev -sudo pip3 install -U setuptools -sudo pip3 install -U wheel -sudo pip3 install -U virtualenvwrapper -sudo pip3 install -U pipenv -``` - -Homebrew can be used to install libgeos-dev in macOS: - -``` -brew install geos -``` +The Python package uses `pyproject.toml` (PEP 517/518) with setuptools as the build backend. We recommend using [uv](https://docs.astral.sh/uv/) to manage virtual environments and dependencies. -6) Set up pipenv to the desired Python version: 3.8, 3.9, or 3.10 - -``` +```bash cd python -pipenv --python 3.8 +python -m pip install --upgrade uv +uv venv --python 3.10 # or any supported version (>=3.8) Review Comment: ```suggestion uv venv --python 3.10 # or any supported version (>=3.8) uv add pip ``` optional: I personally like when setup guides have every single command that a contributor needs to get setup, so they can blindly copy-paste everything over. Otherwise, I can imagine less-experienced developers to be like "did I miss something? is it okay that I ran this myself?" `pip` is needed for this command a few lines down `uv run pip install -e .` ########## docs/setup/compile.md: ########## @@ -106,52 +99,38 @@ wget -P $SPARK_HOME/jars/ https://repo.osgeo.org/repository/release/javax/media/ wget -P $SPARK_HOME/jars/ https://repo.osgeo.org/repository/release/javax/media/jai_imageio/${JAI_IMAGEIO_VERSION}/jai_imageio-${JAI_IMAGEIO_VERSION}.jar ``` -4) Compile the Sedona Scala and Java code with `-Dgeotools` and then copy the ==sedona-spark-shaded-{{ sedona.current_version }}.jar== to ==SPARK_HOME/jars/== folder. +3) Build Sedona Scala/Java jars with GeoTools shaded (from repo root) -``` +```bash +mvn clean install -DskipTests -Dgeotools cp spark-shaded/target/sedona-spark-shaded-*.jar $SPARK_HOME/jars/ ``` -5) Install the following libraries +4) Setup Python development environment -``` -sudo apt-get -y install python3-pip python-dev libgeos-dev -sudo pip3 install -U setuptools -sudo pip3 install -U wheel -sudo pip3 install -U virtualenvwrapper -sudo pip3 install -U pipenv -``` - -Homebrew can be used to install libgeos-dev in macOS: - -``` -brew install geos -``` Review Comment: Curious, was this never needed, or was the need for it removed? I ran `brew uninstall geos` and confirmed this wasn't needed for things to continue to work. -- 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]
