Skip to main content

Autonomous Economic Agent framework

Project description

AEA Framework

PyPI PyPI - Python Version PyPI - Wheel PyPI - Downloads

AEA framework sanity checks and tests Codecov

A framework for autonomous economic agent (AEA) development

Get started

  1. Create and launch a clean virtual environment with Python 3.7 (any Python >= 3.6 works):

    pipenv --python 3.7 && pipenv shell

  2. Install the package from PyPI:

    pip install aea[all]

(pip install "aea[all]" if you use zsh rather than bash.)

  1. Then, build your agent as described in the docs.

AEA

Alternatively: Install from Source

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 dependencies are specified in the Pipfile (and installed via the commands specified in 'Preliminaries').

Or, you can have more control on the installed dependencies by leveraging the setuptools' extras mechanism (more details later).

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]
    

(pip install ".[all]" if you use zsh rather than bash.)

  • 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 following steps are only relevant if you intend to contribute to the repository. They are not required for agent development.

  • Install development dependencies (optionally skipping Lockfile creation):

    pipenv install --dev --skip-lock
    
  • Install package in development mode (this step replaces pip install aea[all] above):

    pip install -e .[all]
    

(pip install -e ".[all]" if you use zsh rather than bash.)

  • To run tests (ensure no oef docker containers are running):

      tox -e py3.7
    
  • To run linters (code style checks):

    tox -e flake8
    
  • To run static type checks:

    tox -e mypy
    
  • To run black code formatter:

    tox -e black
    
  • To run bandit security checks:

    tox -e bandit-main
    tox -e bandit-tests
    
  • Docs:

    • mkdocs serve - Start the live-reloading docs server on localhost.

To amend the docs, create a new documentation file in docs/ and add a reference to it in mkdocs.yml.

  • Fetch 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},
  Title = {Autonomous Economic Agent (AEA) Framework},
  Year = {2019},
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for aea, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size aea-0.3.0-py2.py3-none-any.whl (229.6 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size aea-0.3.0.tar.gz (8.0 MB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page