README.md

Dev-template

A template for development with the open-autonomy framework. Find the documentation here.

System requirements

• Python >=3.8
• Tendermint ==0.34.19
• IPFS node ==0.6.0
• Pip
• Poetry
• Docker Engine
• Docker Compose

Alternatively, you can fetch this docker image with the relevant requirements satisfied:

NOTE: Tendermint and IPFS dependencies are missing from the image at the moment.

docker pull valory/open-autonomy-user:latest
docker container run -it valory/open-autonomy-user:latest

This repository contains:

• Empty directory packages which acts as the local registry

• .env file with Python path updated to include packages directory

How to use

Create a virtual environment with all development dependencies:

poetry shell
poetry install

Get developing...

Useful commands:

Check out the Makefile for useful commands, e.g. make formatters, make generators, make code-checks, as well as make common-checks-1. To run tests use the autonomy test command. Run autonomy test --help for help about its usage.