wenjin272 commented on code in PR #226: URL: https://github.com/apache/flink-agents/pull/226#discussion_r2389667381
########## docs/content/docs/get-started/installation.md: ########## @@ -80,68 +79,24 @@ To clone from Git, run: git clone https://github.com/apache/flink-agents.git ``` -### Java Build +### Build +To run on a Flink cluster, we need build the whole project. -The Python wheel depends on the Flink Agents Java modules, so we need to build Flink Agents Java modules first, run: +We provide a script to run: ```shell cd flink-agents -mvn clean install -DskipTests +./tools/build.sh ``` -### Python Build and Install - -Then we can build and install the Flink Agents wheel. - -{{< tabs>}} -{{< tab "uv (Recommended)" >}} - -uv is a modern, fast Python package manager that offers significant performance -improvements over pip. - -If uv is not installed already, you can install it with the following command: - -```shell -pip install uv -``` -Please see [uv installation](https://docs.astral.sh/uv/getting-started/installation) for more detail. - -```shell -cd python - -# Build sdist and wheel into python/dist/ -uv run python -m build - -# Install the built wheel into the environment -uv pip install dist/*.whl -``` - -{{< /tab >}} - -{{< tab "pip" >}} - -We also support building and installing with pip - -```shell -cd python - -# Build sdist and wheel into python/dist/ -python -m build - -# Install the built wheel into the environment -python -m pip install dist/*.whl -``` - -{{< /tab >}} -{{< /tabs >}} - ### Install Flink Agents to Flink To install the Java dependencies to Flink, run: Review Comment: The python package will be installed to the python interpreter. By export `PYTHONPATH` before run python job. `export PYTHONPATH=$(python -c 'import sysconfig; print(sysconfig.get_paths()["purelib"])')` The standalone cluster can find the python package. -- 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]
