This is an automated email from the ASF dual-hosted git repository.
xtsong pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-agents.git
The following commit(s) were added to refs/heads/main by this push:
new 8a32f08 [doc] Simplify building step in README. (#270)
8a32f08 is described below
commit 8a32f08a02abc09b9abb71ea834561368b421c05
Author: Wenjin Xie <[email protected]>
AuthorDate: Fri Oct 10 15:57:18 2025 +0800
[doc] Simplify building step in README. (#270)
---
README.md | 57 ++++-----------------------------------------------------
tools/build.sh | 1 +
2 files changed, 5 insertions(+), 53 deletions(-)
diff --git a/README.md b/README.md
index 6750203..e3c98c3 100644
--- a/README.md
+++ b/README.md
@@ -20,64 +20,15 @@ To clone from git, enter:
git clone https://github.com/apache/flink-agents.git
```
-### Java Build
-
-To build Flink Agents Java part, run:
-
-```shell
-cd flink-agents
-mvn clean install -DskipTests
-```
-
-### Python Build
-
-#### Using uv (Recommended) — Build and Install
-
-```shell
-cd python
-
-# Install uv (fast Python package manager)
-pip install uv
-
-# Create env and install build dependencies
-uv sync --extra build
-
-# Build sdist and wheel into python/dist/
-uv run python -m build
-
-# Install the built wheel into the environment
-uv pip install dist/*.whl
-```
-
-
-#### Using pip (Alternative) — Build and Install
-
-```shell
-cd python
-
-# Install project (editable) with 'build' extra/tools
-pip install -e .[build]
-
-# Build sdist and wheel into python/dist/
-python -m build
-
-# Install the built wheel into the environment
-python -m pip install dist/*.whl
-```
-
-### Build Python with Flink-Agents jars
-
-This will also package flink-agents jars in wheel, which
-is necessary when run agent as pyflink job.
+We provide a script to build Flink-Agents from source
```shell
# Build java and python
-bash -x tools/build.sh
-
-# Skip building java (must be built already)
-bash -x tools/build.sh -p
+./tools/build.sh
```
+This scrips will build both java and python part, and install the Flink-Agents
dist jar to python wheel package.
+
## How to Contribute
[Contribution Guidelines](.github/CONTRIBUTING.md).
diff --git a/tools/build.sh b/tools/build.sh
index baab628..a70711e 100755
--- a/tools/build.sh
+++ b/tools/build.sh
@@ -51,6 +51,7 @@ cp
"${PROJECT_ROOT}/dist/target/flink-agents-dist-${PROJECT_VERSION}.jar" ${PYTH
# build python
cd python
+pip install uv
uv sync --extra dev
uv run python -m build
uv pip install dist/*.whl
