Merge pull request #387 from fetchai/develop

Develop

HISTORY.rst

@@ -37,3 +37,12 @@ Release History
 - Bump to latest aea version 0.1.2
 - Static type checking with Mypy
 - Test/bug fixes
+
+0.1.6 (2019-09-23)
+-------------------
+
+- Updates docs to latest code base
+- Bumps to latest aea version 0.1.4
+- Adds versioning to TAC via `version_id`
+- Ports `tac` protocol from aea repo
+- Multiple small fixes

Pipfile

@@ -16,7 +16,6 @@ pytest = "*"
 tox = "==3.7.0"
 tox-pipenv = "==1.9.0"
 pytest-cov = "*"
-docker = "*"
 flake8-docstrings = "*"
 pygments = "*"
 mypy = "*"
@@ -33,11 +32,13 @@ oef = {index = "test-pypi",version = "==0.6.10"}
 python-dateutil = "*"
 sphinxcontrib-mermaid = "*"
 sphinxcontrib-apidoc = "*"
-sphinx = "*"
+sphinx = "==2.1.2"
 wtforms = "*"
 visdom = "*"
-aea = {index = "test-pypi",version = "==0.1.2"}
+aea = {index = "pypi",version = "==0.1.4"}
 colorlog = "*"
+docker = "*"
+docker-compose = "*"
 
 [requires]
 python_version = "3.7"

README.md

@@ -8,43 +8,43 @@ This repository contains submodules. Clone with recursive strategy:
 
 	  git clone [email protected]:fetchai/agents-tac.git --recursive && cd agents-tac
 
-## Quick Start:
+## Option 1: Quick Start:
 
-- [x] You have followed the steps under 'Dependencies' and 'Preliminaries' below
-- [x] You have entered the virtual environment and launched the script:
+- [x] Follow the steps under 'Dependencies' and 'Preliminaries' below
+- [x] Enter the virtual environment and launched the script:
 
       pipenv shell
       python scripts/launch.py
 
 The controller GUI at http://localhost:8097 provides real time insights.
 
-## Step by step:
+## Option 2: Step by step:
 
 - [x] You have followed the steps under 'Dependencies' and 'Preliminaries' below
-- [x] In one terminal, you have built the sandbox and then launched it:
+- [x] In one terminal, build the sandbox and then launch it:
 
       cd sandbox && docker-compose build
       docker-compose up
 
-- [x] In another terminal, you have entered the virtual environment and connected a template agent to the sandbox:
+- [x] Optionally, in another terminal, enter the virtual environment and connect a template agent to the sandbox:
 
       pipenv shell
-      python templates/v1/basic.py --name my_agent --gui
+      python templates/v1/basic.py --name my_agent --dashboard
 
 The sandbox is starting up:
 <p align="center">
   <img src="https://github.com/fetchai/agents-tac/blob/master/docs/sandbox.png?raw=true" alt="Sandbox" width="60%"/>
 </p>
 
-Once agent is connecting and searching for the competition:
+Once agent is connected and searching for the competition:
 <p align="center">
   <img src="https://github.com/fetchai/agents-tac/blob/master/docs/agent.png?raw=true" alt="Sandbox" width="60%"/>
 </p>
 
 The controller GUI at http://localhost:8097 provides real time insights:
 ![Controller GUI](../master/docs/controller_gui.png)
 
-- [x] You have had a look at the documentation and are developing your first agent.
+- [x] Have a look at the documentation and start developing your first agent.
 
 ## Quick Links
 
@@ -85,18 +85,22 @@ The [competition sandbox](../master/sandbox) provides the code to build the dock
 ## Dependencies
 
 - All python specific dependencies are specified in the Pipfile (and installed via the commands specified in 'Preliminaries').
-- The package requires that you install [Docker](https://www.docker.com/) and the sanbox requires that you in addition install [Docker Compose](https://docs.docker.com/compose/).
+- The package requires that you install [Docker](https://www.docker.com/) and the sandbox requires that in addition, you install [Docker Compose](https://docs.docker.com/compose/).
 - The project requires oef-search-pluto which can be pulled here:
 
-	  docker pull fetchai/oef-search:latest
+	  docker pull fetchai/oef-search:0.7
 
 ## Preliminaries
 
 - Create and launch a virtual environment:
 
       pipenv --python 3.7 && pipenv shell
+      
+- Install the dependencies:
+
+      pipenv install
 
-- Install the package:
+- Install the tac package:
 
       python setup.py install
 
@@ -137,7 +141,7 @@ The following steps are only relevant if you intend to contribute to the reposit
 
 - We recommend you use the latest OEF build:
 
-	  python oef_search_pluto_scripts/launch.py -c ./oef_search_pluto_scripts/launch_config.json
+	  python scripts/oef/launch.py -c ./scripts/oef/launch_config.json
 
 ## Resources
 

docs/README.md

@@ -36,3 +36,10 @@ firefox _build/html/index.html
 ```
 open _build/html/index.html
 ```
+
+## Publish
+
+```
+./publish_to_ghpages.sh VERSION_TAG
+```
+where `VERSION_TAG` is the version tag of the release.

docs/diagrams/controller_setup.mmd

@@ -4,9 +4,9 @@ sequenceDiagram
 
     Note right of Controller: register as a controller agent.
 
-    Controller->>OEF: register_service("tac", Description{version=1})
+    Controller->>OEF: register_service("tac", Description{version=VERSION_ID})
     Controller->>Controller: run()
     activate Controller
     deactivate Controller
 
-    Note right of Controller: Waiting for 'Register' messages from TAC agents, until 'start time'.
+    Note right of Controller: Waiting for 'REGISTER' messages from TAC agents, until 'start time'.

docs/diagrams/controller_setup.uml

@@ -7,12 +7,12 @@ note right of "Controller"
     register as a controller agent.
 end note
 
-"Controller"->"OEF Node": register_service("tac", Description{version=1})
+"Controller"->"OEF Node": register_service("tac", Description{version=VERSION_ID})
 "Controller"->"Controller": run()
 activate "Controller"
 
 note right of "Controller"
-    Waiting for 'Register' messages from
+    Waiting for 'REGISTER' messages from
     TAC agents, until 'start time'.
 end note
 

docs/reference/api/modules.rst

@@ -0,0 +1,7 @@
+tac
+===
+
+.. toctree::
+   :maxdepth: 4
+
+   tac

docs/reference/api/tac.agents.controller.base.rst

@@ -0,0 +1,70 @@
+tac.agents.controller.base package
+==================================
+
+Submodules
+----------
+
+tac.agents.controller.base.actions module
+-----------------------------------------
+
+.. automodule:: tac.agents.controller.base.actions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tac.agents.controller.base.handlers module
+------------------------------------------
+
+.. automodule:: tac.agents.controller.base.handlers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tac.agents.controller.base.helpers module
+-----------------------------------------
+
+.. automodule:: tac.agents.controller.base.helpers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tac.agents.controller.base.interfaces module
+--------------------------------------------
+
+.. automodule:: tac.agents.controller.base.interfaces
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tac.agents.controller.base.reactions module
+-------------------------------------------
+
+.. automodule:: tac.agents.controller.base.reactions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tac.agents.controller.base.states module
+----------------------------------------
+
+.. automodule:: tac.agents.controller.base.states
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tac.agents.controller.base.tac\_parameters module
+-------------------------------------------------
+
+.. automodule:: tac.agents.controller.base.tac_parameters
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: tac.agents.controller.base
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/reference/api/tac.agents.controller.rst

@@ -0,0 +1,29 @@
+tac.agents.controller package
+=============================
+
+Subpackages
+-----------
+
+.. toctree::
+
+   tac.agents.controller.base
+
+Submodules
+----------
+
+tac.agents.controller.agent module
+----------------------------------
+
+.. automodule:: tac.agents.controller.agent
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: tac.agents.controller
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/reference/api/tac.agents.participant.rst

@@ -0,0 +1,18 @@
+tac.agents.participant package
+==============================
+
+Subpackages
+-----------
+
+.. toctree::
+
+   tac.agents.participant.v1
+   tac.agents.participant.v2
+
+Module contents
+---------------
+
+.. automodule:: tac.agents.participant
+   :members:
+   :undoc-members:
+   :show-inheritance: