Metadata-Version: 2.4
Name: open-aea-cli-benchmark
Version: 2.2.6
Summary: CLI extension for AEA framework benchmarking.
Author: Valory AG
License: Apache-2.0
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Communications
Classifier: Topic :: Internet
Classifier: Topic :: Software Development
Requires-Python: >=3.10,<3.15
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: open-aea<3.0.0,>=2.0.0
Requires-Dist: psutil<6.0.0,>=5.7.0
Requires-Dist: click<8.4.0,>=8.1.0
Requires-Dist: cosmpy<0.12,>=0.11.0
Provides-Extra: tx-generate
Requires-Dist: docker==7.1.0; extra == "tx-generate"
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# AEA CLI Benchmark Plug-in

CLI extension for benchmarking the AEA framework. Adds an `aea benchmark` command group that runs performance benchmark cases covering agent construction, message throughput, memory usage, decision maker, ACN, and related scenarios.

## Installation and usage

Make sure you have `aea` installed.

Then, install the plug-in:
```bash
pip install open-aea-cli-benchmark
```

The `tx-generate` case spins up a dockerised fetchai ledger node and is therefore an optional extra. Install it with:
```bash
pip install "open-aea-cli-benchmark[tx-generate]"
```
Without the `[tx-generate]` extra the `tx-generate` command is not registered and the rest of the benchmark commands work as normal.

Now you should be able to run `aea benchmark`:

```bash
Usage: aea benchmark [OPTIONS] COMMAND [ARGS]...

  Run one of the performance benchmarks.

Options:
  --help  Show this message and exit.

Commands:
  acn-communication             ACN end-to-end message throughput
  acn-startup                   ACN node startup time
  agent-construction-time       Time to construct an AEA instance
  decision-maker                Decision maker throughput
  dialogues-memory-usage        Memory footprint of dialogue state
  mem-usage                     Agent memory usage under load
  messages-memory-usage         Memory footprint of messages
  multiagent                    Multi-agent throughput
  multiagent-http-dialogues     Multi-agent HTTP dialogue throughput
  proactive                     Proactive skill behaviour benchmark
  reactive                      Reactive skill handler benchmark
  tx-generate                   Transaction generation throughput (requires the [tx-generate] extra)
```

Run any command with `--help` for per-case options.
