Skip to main content

Autonomous Economic Agent framework

Project description

agents-aea

A framework for autonomous economic agent (AEA) development

Get started

  • Create and launch a virtual environment with Python 3.7:

    pipenv --python 3.7 && pipenv shell
    
  • Install the package from pypi:

    pip install aea[all]
    
  • Then, build your agent as described in the docs.

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:

    pipenv --python 3.7 && pipenv shell
    
  • Install the package from source:

    pip install .[all]
    
  • To install only specific extra dependencies, e.g. cli:

    pip install .[cli]
    

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:

    pipenv install --dev
    
  • Install package in (development mode):

    pip install -e .
    
  • After changes to the protobuf schema run:

    python setup.py protoc
    
  • To run tests (ensure no oef docker containers are running):

    tox -e py37
    
  • To run linters (code style checks):

    tox -e flake8
    
  • To run static type checks:

    tox -e mypy
    
  • 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.

Project details


Download files

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

Source Distribution

aea-0.1.13.tar.gz (116.6 kB view hashes)

Uploaded Source

Built Distribution

aea-0.1.13-py2.py3-none-any.whl (163.3 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page