Apache Flink Agents

Apache Flink Agents is an Agentic AI framework based on Apache Flink.

Building

Prerequisites for building Flink Agents:

• Unix-like environment (we use Linux, Mac OS X, Cygwin, WSL)
• Git
• Maven
• Java 11
• Python 3 (3.9, 3.10, 3.11 or 3.12)

To clone from git, enter:

git clone https://github.com/apache/flink-agents.git

Java Build

To build Flink Agents Java part, run:

cd flink-agents
mvn clean install -DskipTests

Python Build

Using uv (Recommended)

Firstly, install uv and build dependencies:

pip install uv
cd python
uv sync --extra build

Then build the package:

uv run python -m build

Using pip (Traditional)

Alternatively, you can use traditional pip:

cd python
pip install -e .[build]
python -m build

The sdist and wheel package of flink-agents will be found under ./python/dist/. Either of them could be used for installation:

# Using uv
uv pip install python/dist/*.whl

# Using pip
python -m pip install python/dist/*.whl

Note: The requirements/*.txt files are deprecated. Please use the modern pyproject.toml dependency groups. See python/MIGRATION_GUIDE.md for details.

How to Contribute

Contribution Guidelines.