This is an automated email from the ASF dual-hosted git repository.
wenjin272 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 d11488ac [doc] Fix installation guide: Maven version, Python 3.12
note, macOS arm64 pip workaround (#823)
d11488ac is described below
commit d11488ac19dfbff039dea97f243ab8fd391f07d6
Author: Wenjin Xie <[email protected]>
AuthorDate: Tue Jun 9 19:05:31 2026 +0800
[doc] Fix installation guide: Maven version, Python 3.12 note, macOS arm64
pip workaround (#823)
Co-authored-by: Claude Opus 4.8 (1M context) <[email protected]>
---
docs/content/docs/get-started/installation.md | 15 ++++++++++++---
1 file changed, 12 insertions(+), 3 deletions(-)
diff --git a/docs/content/docs/get-started/installation.md
b/docs/content/docs/get-started/installation.md
index 89b794db..3bcef313 100644
--- a/docs/content/docs/get-started/installation.md
+++ b/docs/content/docs/get-started/installation.md
@@ -55,7 +55,7 @@ When using the **Java API**, there are some functionality
limitations for earlie
| Java 11-20 | Async execution is unavailable. |
{{< hint info >}}
-**Note**: If you want to use python 3.12, you need install Flink above 2.1
(including 2.1).
+**Note**: Python 3.12 requires Flink 2.1 or above and Flink Agents 0.3 or
above.
{{< /hint >}}
## Quick install (recommended)
@@ -137,6 +137,15 @@ Install Flink Agents using pip:
pip install flink-agents apache-flink==${FLINK_VERSION}
```
+{{< hint warning >}}
+**Apple Silicon (macOS arm64) + Python 3.12**: `apache-flink` depends on
`apache-beam`, which ships no macOS arm64 wheel for Python 3.12, so pip builds
it from source. The build pulls the latest `setuptools` (>=82), which removed
`pkg_resources`, causing `ModuleNotFoundError: No module named 'pkg_resources'`
(an upstream issue — see
[setuptools#5174](https://github.com/pypa/setuptools/issues/5174)). Constrain
the build's setuptools to fix it:
+
+```shell
+echo "setuptools<82" > /tmp/constraint.txt
+PIP_CONSTRAINT=/tmp/constraint.txt pip install flink-agents
apache-flink==${FLINK_VERSION}
+```
+{{< /hint >}}
+
#### From Source
**Clone the repository:**
@@ -278,8 +287,8 @@ For execution in IDE, enable the feature `add dependencies
with provided scope t
```xml
<properties>
- <flink.version>2.2</flink.version>
- <flink-agents.version>0.2.0</flink-agents.version>
+ <flink.version>2.2.1</flink.version>
+ <flink-agents.version>0.3.0</flink-agents.version>
</properties>
<dependencies>
