1. Installation¶

Ready to get started with AgentScope Runtime? This guide will help you get up and running with AgentScope Runtime in just a few minutes.

Installation Methods¶

Agentscope Runtime supports two installation methods: PyPI and from source. Both methods require Python 3.10 or higher.

Install via PyPI¶

To install the stable release of Agentscope Runtime via PyPI, use:

pip install agentscope-runtime

# For additional extensions, install with extras:
pip install "agentscope-runtime[ext]"

(Optional) Install preview version (Beta/RC)¶

If you want to try features that have not been officially released yet, you can install the latest preview version:

pip install --pre agentscope-runtime

Note

Note: Preview versions may contain features or interface changes that are not fully stable yet. It is recommended to use them in a testing environment.

(Optional) Install from Source¶

If you want to use the latest development version or contribute to the project, you can install from source:

git clone https://github.com/agentscope-ai/agentscope-runtime.git

cd agentscope-runtime

pip install .

For development, you may want to install with development dependencies:

pip install ".[dev]"

Check Your Installation¶

To verify your installation and check the current version, run the following in Python:

import agentscope_runtime

print(f"AgentScope Runtime {agentscope_runtime.__version__} is ready!")

You should see the version number printed out.

Installation Options Explained¶

The core runtime (agentscope-runtime) includes AgentScope Framework and Sandbox dependencies. See details about all installation options at pyproject.toml.

Component	Package	Use-Case	Dependencies
Core Runtime	`agentscope-runtime`	Core runtime	Minimal including AgentScope Framework and Sandbox Dependencies
Development Tools	`dev`	Dev utilities	Testing, Linting, Docs
Extention	`ext`	Deployment	REME AI, Mem0, Alibaba Cloud services, TableStore, LangChain, Azure Speech, OSS, Authentication, Build tools