Merge pull request #336 from fetchai/develop

Merge develop into master for release 0.1.3
fetchai · Aug 9, 2019 · 1d5036c · 1d5036c
2 parents 6cfe6db + 0eb7d96
commit 1d5036c
Show file tree

Hide file tree

Showing 104 changed files with 3,943 additions and 927 deletions.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -14,4 +14,12 @@ Release History
 0.1.2 (2019-07-08)
 -------------------
 
-- Minor updates, many bug fixes, no breaking changes.
+- Minor updates, many bug fixes, no breaking changes.
+
+0.1.3 (2019-08-09)
+-------------------
+
+- Updated to OEF SDK version 0.6
+- Improved documentation by adding detailed guides
+- Added more tools/features to support the developer (e.g. the launcher app)
+
diff --git a/LICENSE b/LICENSE
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2019 Fetch.AI Limited
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -8,3 +8,4 @@ recursive-include templates *
 recursive-include sandbox *
 recursive-include simulation *
 recursive-include scripts *
+recursive-include oef_search_pluto_scripts *
diff --git a/Pipfile b/Pipfile
@@ -3,12 +3,18 @@ name = "pypi"
 url = "https://pypi.org/simple"
 verify_ssl = true
 
+[[source]]
+url = "https://test.pypi.org/simple"
+verify_ssl = true
+name = "test-pypi"
+
 [dev-packages]
 flake8 = "*"
 ipython = "*"
 jupyter = "*"
 pytest = "*"
 tox = "*"
+tox-pipenv = "*"
 pytest-cov = "*"
 docker = "*"
 flake8-docstrings = "*"
@@ -20,11 +26,14 @@ python-dateutil = "*"
 visdom = "*"
 cryptography = "*"
 base58 = "*"
-oef = "==0.4.0"
+fetchai-ledger-api = {git = "https://github.com/fetchai/ledger-api-py.git",
+oef = {version="*", index="test-pypi"}
 sphinxcontrib-mermaid = "*"
 sphinxcontrib-apidoc = "*"
 sphinx = "*"
 nbsphinx = "*"
+flask-restful = "*"
+wtforms = "*"
 
 [requires]
 python_version = "3.7"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -8,7 +8,17 @@ This repository contains submodules. Clone with recursive strategy:
 
 	  git clone [email protected]:fetchai/agents-tac.git --recursive && cd agents-tac
 
-## Quick Start
+## Quick Start:
+
+- [x] You have followed the steps under 'Dependencies' and 'Preliminaries' below
+- [x] You have entered 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:
 
 - [x] You have followed the steps under 'Dependencies' and 'Preliminaries' below
 - [x] In one terminal, you have built the sandbox and then launched it:
@@ -19,7 +29,7 @@ This repository contains submodules. Clone with recursive strategy:
 - [x] In another terminal, you have entered the virtual environment and connected a template agent to the sandbox:
 
       pipenv shell
-      python3 templates/v1/basic.py --name my_agent --gui
+      python templates/v1/basic.py --name my_agent --gui
 
 The sandbox is starting up:
 <p align="center">
@@ -88,7 +98,7 @@ The [competition sandbox](../master/sandbox) provides the code to build the dock
 
 - Install the package:
 
-      python3 setup.py install
+      python setup.py install
 
 ## Contribute
 
@@ -97,6 +107,10 @@ The following dependency is only relevant if you intend to contribute to the rep
 
 The following steps are only relevant if you intend to contribute to the repository. They are not required for agent development.
 
+- Clear cache
+
+      pipenv --clear
+
 - Install development dependencies:
 
 	  pipenv install --dev
@@ -119,7 +133,7 @@ The following steps are only relevant if you intend to contribute to the reposit
 
 - We recommend you use the latest OEF build:
 
-	  python3 oef_search_pluto_scripts/launch.py -c ./oef_search_pluto_scripts/launch_config_latest.json
+	  python oef_search_pluto_scripts/launch.py -c ./oef_search_pluto_scripts/launch_config_latest.json
 
 ## Resources
 

diff --git a/docker-tac-develop/Dockerfile b/docker-tac-develop/Dockerfile
@@ -51,19 +51,14 @@ RUN sudo apt install python3.7-dev -y
 RUN sudo apt install python3-pip -y
 RUN sudo pip install pipenv
 
-## Docs dependencies:
-#RUN apt install pandoc -y
-## python package to parse plantuml files. docs: https://pythonhosted.org/plantuml/
-#RUN apt install plantuml -y
-
 RUN sudo mkdir /build
 WORKDIR /build
 COPY . /build
 
 RUN sudo make clean
 
 RUN pipenv --python python3.7
-RUN pipenv install --dev --skip-lock
-RUN pipenv run pip3 install . --no-cache-dir --force
+RUN pipenv install --dev 
+RUN pipenv run pip3 install .
 
 ENTRYPOINT []
diff --git a/docs/README.md b/docs/README.md
@@ -1,10 +1,15 @@
 # TAC Documentation
 
+## Dependency
+
+This requires `pandoc` to be installed locally.  See [here](https://pandoc.org/installing.html) for instructions.
+
 ## Build
 
 - Before getting started, check that:
 
   - [x] You have followed the steps under 'Dependencies' and 'Preliminaries' on root readme.
+  - [x] You have installed the development dependencies as described on root readme.
 
 - Activate the virtual environment:
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -31,14 +31,15 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.mathjax',
-              'sphinx.ext.githubpages',
-              'nbsphinx',
-              'sphinxcontrib.mermaid',
-              'sphinx.ext.todo',
-              'sphinx.ext.autodoc',
-              'sphinx.ext.autosectionlabel',
-              'sphinx.ext.intersphinx'
+extensions = [
+    'sphinx.ext.mathjax',
+    'sphinx.ext.githubpages',
+    'nbsphinx',
+    'sphinxcontrib.mermaid',
+    'sphinx.ext.todo',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosectionlabel',
+    'sphinx.ext.intersphinx',
 ]
 
 # autodoc conf
@@ -67,14 +68,15 @@
 copyright = '2019, Fetch.AI'
 author = 'Fetch.AI'
 
+from tac import __version__
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.1.2'
+version = __version__
 # The full version, including alpha/beta/rc tags.
-release = '0.1.2'
+release = __version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -112,7 +114,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.

diff --git a/docs/diagrams/agent-state-management-guide/summary.mmd b/docs/diagrams/agent-state-management-guide/summary.mmd
@@ -0,0 +1,45 @@
+sequenceDiagram
+
+    participant Agent_1
+
+    participant Agent_2
+
+    participant Controller
+
+    activate Controller
+
+    Agent_1->>Agent_2: (1) send_cfp(1, 1, "agent_2_pbk", 0, query)
+
+    Agent_2->>Agent_2: (2) get_proposal()
+    Agent_2->>Agent_2: (3) add_pending_proposal()
+
+    Agent_2->>Agent_1: (4) send_propose(2, 1, "agent_1_pbk", 1, proposals)
+
+    Agent_1->>Agent_1: (5) is_profitable_transaction()
+    Agent_1->>Agent_1: (6) add_locked_tx()
+    Agent_1->>Agent_1: (7) add_pending_initial_acceptance()
+
+    Agent_1->>Agent_2: (8) send_accept(3, 1, "agent_2_pbk", 2)
+
+    Agent_2->>Agent_2: (9) pop_pending_proposal()
+    Agent_2->>Agent_2: (10) is_profitable_transaction()
+    Agent_2->>Agent_2: (11) add_locked_tx()
+
+    Agent_2->>Agent_1: (12) send_accept(4, 1, "agent_1_pbk", 3)
+    Agent_2->>Controller: (13) send_message(4, 1, "controller_pbk", transaction)
+
+    Agent_1->>Agent_1: (14) pop_pending_initial_acceptance()
+
+    Agent_1->>Controller: (15) send_message(5, 1, "controller_pbk", transaction)
+
+    Controller->>Agent_1: (16) TransactionConfirmation(transaction)
+
+    Agent_1->>Agent_1: (17) pop_locked_tx()
+    Agent_1->>Agent_1: (18) agent_state.update()
+
+    Controller->>Agent_2: (19) TransactionConfirmation(transaction)
+
+    Agent_2->>Agent_2: (20) pop_locked_tx()
+    Agent_2->>Agent_2: (21) agent_state.update()
+
+    deactivate Controller
diff --git a/docs/_static/diagrams/controller_setup.mmd → docs/diagrams/controller_setup.mmd b/docs/_static/diagrams/controller_setup.mmd → docs/diagrams/controller_setup.mmd
diff --git a/docs/_static/diagrams/controller_setup.uml → docs/diagrams/controller_setup.uml b/docs/_static/diagrams/controller_setup.uml → docs/diagrams/controller_setup.uml
diff --git a/docs/_static/diagrams/fipa_negotiation_1.mmd → docs/diagrams/fipa_negotiation_1.mmd b/docs/_static/diagrams/fipa_negotiation_1.mmd → docs/diagrams/fipa_negotiation_1.mmd
diff --git a/docs/_static/diagrams/fipa_negotiation_2.mmd → docs/diagrams/fipa_negotiation_2.mmd b/docs/_static/diagrams/fipa_negotiation_2.mmd → docs/diagrams/fipa_negotiation_2.mmd
diff --git a/docs/_static/diagrams/fipa_negotiation_3.mmd → docs/diagrams/fipa_negotiation_3.mmd b/docs/_static/diagrams/fipa_negotiation_3.mmd → docs/diagrams/fipa_negotiation_3.mmd
diff --git a/docs/_static/diagrams/fipa_negotiation_4.mmd → docs/diagrams/fipa_negotiation_4.mmd b/docs/_static/diagrams/fipa_negotiation_4.mmd → docs/diagrams/fipa_negotiation_4.mmd
diff --git a/docs/diagrams/negotiation-guide/summary.mmd b/docs/diagrams/negotiation-guide/summary.mmd
@@ -0,0 +1,41 @@
+sequenceDiagram
+
+    participant Agent_1
+
+    participant Agent_2
+
+    participant Controller
+
+    participant OEF
+
+
+
+    activate Controller
+
+    Agent_1->>Agent_1: (1) get_service_description()
+    Agent_1->>OEF: (2) register_service(description)
+
+    Agent_2->>Agent_2: (3) get_service_description()
+    Agent_2->>OEF: (4) register_service(description)
+
+    Agent_1->>Agent_1: (5) build_services_query()
+    Agent_1->>OEF: (6) search_services(query)
+
+    OEF->>Agent_1: (7) search_results(agents)
+
+    Agent_1->>Agent_2: (8) send_cfp(1, 1, "agent_2_pbk", 0, query)
+    Agent_2->>Agent_2: (9) get_proposal()
+
+    Agent_2->>Agent_1: (10) send_propose(2, 1, "agent_1_pbk", 1, proposals)
+
+    Agent_1->>Agent_2: (11) send_accept(3, 1, "agent_2_pbk", 2)
+
+    Agent_2->>Agent_1: (13) send_accept(4, 1, "agent_1_pbk", 3)
+    Agent_2->>Controller: (14) send_message(4, 1, "controller_pbk", transaction)
+
+    Agent_1->>Controller: (12) send_message(5, 1, "controller_pbk", transaction)
+
+    Controller->>Agent_1: (15) TransactionConfirmation(transaction)
+    Controller->>Agent_2: (16) TransactionConfirmation(transaction)
+
+    deactivate Controller
diff --git a/docs/_static/diagrams/register_to_tac.mmd → docs/diagrams/register_to_tac.mmd b/docs/_static/diagrams/register_to_tac.mmd → docs/diagrams/register_to_tac.mmd
diff --git a/docs/_static/diagrams/register_to_tac.uml → docs/diagrams/register_to_tac.uml b/docs/_static/diagrams/register_to_tac.uml → docs/diagrams/register_to_tac.uml
diff --git a/docs/_static/diagrams/registration.mmd → docs/diagrams/registration.mmd b/docs/_static/diagrams/registration.mmd → docs/diagrams/registration.mmd
diff --git a/docs/_static/diagrams/registration.uml → docs/diagrams/registration.uml b/docs/_static/diagrams/registration.uml → docs/diagrams/registration.uml
diff --git a/docs/_static/diagrams/search_controller.mmd → docs/diagrams/search_controller.mmd b/docs/_static/diagrams/search_controller.mmd → docs/diagrams/search_controller.mmd
diff --git a/docs/_static/diagrams/search_controller.uml → docs/diagrams/search_controller.uml b/docs/_static/diagrams/search_controller.uml → docs/diagrams/search_controller.uml
diff --git a/docs/index.rst b/docs/index.rst
@@ -16,6 +16,8 @@ Welcome to TAC's documentation!
    sections/controller_protocol
    sections/baseline_agent
    sections/develop_agent
+   sections/negotiation_guide
+   sections/agent_state_management_guide
    sections/glossary
 
    reference/api/tac

diff --git a/docs/publish_to_ghpages.sh b/docs/publish_to_ghpages.sh
@@ -0,0 +1,40 @@
+#!/bin/bash
+
+if [ -z $1 ]
+then
+	echo "Please provide a tag argument."
+    exit 1;
+fi
+
+STATUS="$(git status)"
+
+if ! [[ $STATUS == *"nothing to commit, working tree clean"* ]]
+then
+    echo "The working directory is dirty. Please commit any pending changes."
+    exit 1;
+fi
+
+set -e
+
+echo "Deleting old publication"
+rm -rf _build
+
+echo "Cloning gh-pages branch"
+mkdir _build -p
+cd _build
+git clone --single-branch --branch gh-pages [email protected]:fetchai/agents-tac.git html
+cd ..
+
+echo "Building docs"
+sphinx-apidoc -o reference/api/ ../tac/
+make html
+cd _build/html
+
+echo "Pushing to gh-pages branch"
+git add --all && git commit -m "Publish docs ($1)"
+git tag $1
+git push origin gh-pages
+
+echo "Delete local repo"
+cd ../../
+make clean
diff --git a/docs/reference/api/tac.agents.v1.base.rst b/docs/reference/api/tac.agents.v1.base.rst
@@ -52,14 +52,6 @@ tac.agents.v1.base.interfaces module
    :undoc-members:
    :show-inheritance:
 
-tac.agents.v1.base.lock\_manager module
----------------------------------------
-
-.. automodule:: tac.agents.v1.base.lock_manager
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 tac.agents.v1.base.negotiation\_behaviours module
 -------------------------------------------------
 
@@ -100,6 +92,14 @@ tac.agents.v1.base.strategy module
    :undoc-members:
    :show-inheritance:
 
+tac.agents.v1.base.transaction\_manager module
+----------------------------------------------
+
+.. automodule:: tac.agents.v1.base.transaction_manager
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 
 Module contents
 ---------------

diff --git a/docs/reference/api/tac.gui.dashboards.rst b/docs/reference/api/tac.gui.dashboards.rst
@@ -28,6 +28,14 @@ tac.gui.dashboards.controller module
    :undoc-members:
    :show-inheritance:
 
+tac.gui.dashboards.leaderboard module
+-------------------------------------
+
+.. automodule:: tac.gui.dashboards.leaderboard
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 
 Module contents
 ---------------