AEA Framework

A framework for autonomous economic agent (AEA) development

Get started

Create and launch a clean virtual environment with Python 3.7 (any Python >= 3.6 works):
```
pipenv --python 3.7 && pipenv shell
```
Install the package from PyPI:
```
pip install aea[all]
```
Or, if you use zsh rather than bash:
```
pip install "aea[all]"
```
Then, build your agent as described in the docs.

Alternatively: Install from Source

This approach is not recommended!

Cloning

This repository contains submodules. Clone with recursive strategy:

git clone https://github.com/fetchai/agents-aea.git --recursive && cd agents-aea

Dependencies

All python specific framework dependencies are specified in setup.py and installed with the framework. All development dependencies are specified in Pipfile (and installed via the commands specified in Preliminaries).

You can have more control on the installed dependencies by leveraging the setuptools' extras mechanism.

Preliminaries

Create and launch a virtual environment with Python 3.7 (any Python >= 3.6 works):
```
pipenv --python 3.7 && pipenv shell
```
Install the package from source:
```
pip install .[all]
```
Or, if you use zsh rather than bash:
```
pip install ".[all]"
```
Then, build your agent as described in the docs.

Contribute

The following dependency is only relevant if you intend to contribute to the repository:

The project uses Google Protocol Buffers compiler for message serialization. A guide on how to install it is found here.

The following steps are only relevant if you intend to contribute to the repository. They are not required for agent development.

To install development dependencies (here optionally skipping Pipfile.lock creation):
```
pipenv install --dev --skip-lock
```
To install the package from source in development mode:
```
pip install -e .[all]
```
Of, if you use zsh rather than bash:
```
pip install -e ".[all]"
```
To run tests:
```
tox -e py3.7
```
To run linters (code style checks):
```
tox -e flake8
tox -e pylint
```
To run static type checks:
```
tox -e mypy
```
To run black code formatter:
```
tox -e black
```
To run bandit security checks:
```
tox -e bandit
```
To start a live-reloading docs server on localhost
```
mkdocs serve
```
To amend the docs, create a new documentation file in docs/ and add a reference to it in mkdocs.yml.

To fetch/update submodules:

git submodule sync --recursive && git submodule update --init --recursive

Cite

If you are using our software in a publication, please consider to cite it with the following BibTex entry:

@misc{agents-aea,
  Author = {Marco Favorito and David Minarsch and Ali Hosseini and Aristotelis Triantafyllidis and Diarmid Campbell and Oleg Panasevych and Kevin Chen and Yuri Turchenkov and Lokman Rahmani},
  Title = {Autonomous Economic Agent (AEA) Framework},
  Year = {2019},
}

MissingNO57/agents-aea