Metadata-Version: 2.4
Name: econagents
Version: 0.1.1
Summary: A Python library that lets you use LLM agents in economic experiments.
Project-URL: Homepage, https://github.com/IBEX-TUDelft/econagents
Project-URL: Repository, https://github.com/IBEX-TUDelft/econagents
Author-email: Dylan Castillo <dylan@iwanalabs.com>
License-Expression: MIT
License-File: LICENSE
Requires-Python: <4,>=3.10
Requires-Dist: jinja2>=3.1
Requires-Dist: openai>=1.89.0
Requires-Dist: pydantic>=2.11.5
Requires-Dist: pyyaml>=6.0
Requires-Dist: requests>=2.32.4
Requires-Dist: websockets>=15.0
Provides-Extra: all
Requires-Dist: langfuse>=3.0.3; extra == 'all'
Requires-Dist: langsmith>=0.4.1; extra == 'all'
Requires-Dist: ollama>=0.5.1; extra == 'all'
Provides-Extra: langfuse
Requires-Dist: langfuse>=3.0.3; extra == 'langfuse'
Provides-Extra: langsmith
Requires-Dist: langsmith>=0.4.1; extra == 'langsmith'
Provides-Extra: ollama
Requires-Dist: ollama>=0.5.1; extra == 'ollama'
Provides-Extra: standard
Requires-Dist: langsmith>=0.4.1; extra == 'standard'
Description-Content-Type: text/markdown

<div align="center">
  <img src="https://raw.githubusercontent.com/IBEX-TUDelft/econagents/main/assets/logo_200w.png">
</div>

<div align="center">

![Python compat](https://img.shields.io/badge/%3E=python-3.10-blue.svg)
[![PyPi](https://img.shields.io/pypi/v/econagents.svg)](https://pypi.python.org/pypi/econagents)
[![GHA Status](https://github.com/IBEX-TUDelft/econagents/actions/workflows/tests.yaml/badge.svg?branch=main)](https://github.com/IBEX-TUDelft/econagents/actions?query=workflow%3Atests)
[![Documentation Status](https://readthedocs.org/projects/econagents/badge/?version=latest)](https://econagents.readthedocs.io/en/latest/?badge=latest)

</div>

---

# econagents

econagents is a Python library that lets you use LLM agents in economic experiments. The framework connects LLM agents to game servers through WebSockets and provides a flexible architecture for designing, customizing, and running economic simulations.

## Key Features

- **Flexible Agent Customization**: Customize agent behavior with Jinja templates or custom Python methods
- **Persistent personality can be set**: Built-in support to assign personalities to LLM players, example shown in Public goods game
- **Event-Driven State Management**: Automatically update game state based on server events
- **Turn-Based and Continuous Action Support**: Handle both turn-based games and continuous action phases

## Installation

```shell
# Install from PyPI
pip install econagents

# Or install directly from GitHub
pip install git+https://github.com/IBEX-TUDelft/econagents.git
```

## Framework Components

econagents consists of four key components:

1. **Agent Roles**: Define player roles with customizable behaviors using a flexible prompt system.
2. **Game State**: Hierarchical state management with automatic event-driven updates.
3. **Agent Managers**: Manage agent connections to game servers and handle event processing.
4. **Game Runner**: Orchestrates experiments by gluing together the other components.

## Example Experiments

The repository includes three example games:

1. **`prisoner`**: An iterated Prisoner's Dilemma game with 5 rounds and 2 LLM agents, runs on a local python server (included).
2. **`dictator`**: A modified Dictator game with 2 LLM agents that runs on a local python server (included).
3. **`public_goods`**: A public goods game with 4 players that runs on a local python server (included).

### Running the Prisoner's Dilemma game

The simplest game to run is a version of the repeated prisoner's dilemma game that runs on your local machine.

```shell
# Run the server
python examples/prisoner/server/server.py

# Run the experiment (in a separate terminal)
python examples/prisoner/run_game.py
```

Note: you still have to set up the connection to the agents.

## Documentation

For detailed guides and API reference, visit [the documentation](https://econagents.readthedocs.io/en/latest/).

You should also check out the [econagents cookbook](https://github.com/iwanalabs/econagents-cookbook/tree/main/) for more examples.
