This is an automated email from the ASF dual-hosted git repository.
xtsong pushed a commit to branch release-0.2
in repository https://gitbox.apache.org/repos/asf/flink-agents.git
The following commit(s) were added to refs/heads/release-0.2 by this push:
new 8a20a4c7 [example] Support submit the example in installed
flink-agents wheel to flink cluster.
8a20a4c7 is described below
commit 8a20a4c703d3d1450c45458a97591894101ad04e
Author: WenjinXie <[email protected]>
AuthorDate: Thu Jan 29 16:50:50 2026 +0800
[example] Support submit the example in installed flink-agents wheel to
flink cluster.
---
docs/content/docs/get-started/quickstart/react_agent.md | 6 ++++++
docs/content/docs/get-started/quickstart/workflow_agent.md | 8 ++++++++
python/pyproject.toml | 1 +
3 files changed, 15 insertions(+)
diff --git a/docs/content/docs/get-started/quickstart/react_agent.md
b/docs/content/docs/get-started/quickstart/react_agent.md
index 39c9b731..f1f763c3 100644
--- a/docs/content/docs/get-started/quickstart/react_agent.md
+++ b/docs/content/docs/get-started/quickstart/react_agent.md
@@ -223,6 +223,10 @@ Follow the [installation]({{< ref
"docs/get-started/installation" >}}) instructi
git clone https://github.com/apache/flink-agents.git
cd flink-agents
```
+{{< hint info >}}
+For python examples, you can skip this step and submit the python file in
installed flink-agents wheel.
+{{< /hint >}}
+
#### Deploy a Standalone Flink Cluster
@@ -279,6 +283,8 @@ export PYTHONPATH=$(python -c 'import sysconfig;
print(sysconfig.get_paths()["pu
# Run review analysis example
$FLINK_HOME/bin/flink run -py
./flink-agents/python/flink_agents/examples/quickstart/react_agent_example.py
+# or submit the example python file in installed flink-agents wheel
+$FLINK_HOME/bin/flink run -py
$PYTHONPATH/flink_agents/examples/quickstart/react_agent_example.py
```
{{< /tab >}}
diff --git a/docs/content/docs/get-started/quickstart/workflow_agent.md
b/docs/content/docs/get-started/quickstart/workflow_agent.md
index 76b0d62e..65fa5e8e 100644
--- a/docs/content/docs/get-started/quickstart/workflow_agent.md
+++ b/docs/content/docs/get-started/quickstart/workflow_agent.md
@@ -354,6 +354,10 @@ git clone https://github.com/apache/flink-agents.git
cd flink-agents
```
+{{< hint info >}}
+For python examples, you can skip this step and submit the python file in
installed flink-agents wheel.
+{{< /hint >}}
+
#### Deploy a Standalone Flink Cluster
You can deploy a standalone Flink cluster in your local environment with the
following command.
@@ -408,9 +412,13 @@ export PYTHONPATH=$(python -c 'import sysconfig;
print(sysconfig.get_paths()["pu
# Run review analysis example
$FLINK_HOME/bin/flink run -py
./flink-agents/python/flink_agents/examples/quickstart/workflow_single_agent_example.py
+# or submit the example python file in installed flink-agents wheel
+$FLINK_HOME/bin/flink run -py
$PYTHONPATH/flink_agents/examples/quickstart/workflow_single_agent_example.py
# Run product suggestion example
$FLINK_HOME/bin/flink run -py
./flink-agents/python/flink_agents/examples/quickstart/workflow_multiple_agent_example.py
+# or submit the example python file in installed flink-agents wheel
+$FLINK_HOME/bin/flink run -py
$PYTHONPATH/flink_agents/examples/quickstart/workflow_multiple_agent_example.py
```
{{< /tab >}}
diff --git a/python/pyproject.toml b/python/pyproject.toml
index 40b13bd2..f67d4f98 100644
--- a/python/pyproject.toml
+++ b/python/pyproject.toml
@@ -64,6 +64,7 @@ where = [""]
[tool.setuptools.package-data]
"flink_agents.lib" = ["**/*.jar"]
+"flink_agents.examples.quickstart.resources" = ["**/*.txt"]
# Optional dependencies (dependency groups)
[project.optional-dependencies]
