Merge branch 'v10' into feature/v11-test-updates

README.md

@@ -3,28 +3,14 @@
 
 The volttron-listener agent prints all message traffic across a VOLTTRON bus to standard out.
 
-## Requirements
+## Pre-requisite
 
- - Python >= 3.8
+Before installing this agent, VOLTTRON (>=11.0.0rc0) should be installed and running.  Its virtual environment should be active.
+Information on how to install of the VOLTTRON platform can be found
+[here](https://github.com/eclipse-volttron/volttron-core/tree/v10)
 
 ## Installation
 
-Create and activate a virtual environment.
-
-```shell
-python -m venv env
-source env/bin/activate
-```
-
-Installing volttron-listener requires a running volttron instance.
-
-```shell
-pip install volttron
-
-# Start platform with output going to volttron.log
-volttron -vv -l volttron.log &
-```
-
 Install and start the volttron-listener.
 
 ```shell

pyproject.toml

@@ -2,25 +2,29 @@
 name = "volttron-listener"
 version = "2.0.0rc2"
 description = "The volttron-listener agent allows publishing of message bus traffic to standard out."
-authors = ["VOLTTRON Team <[email protected]>"]
+authors = [
+    "VOLTTRON Team <[email protected]>",
+]
 license = "Apache License 2.0"
 readme = "README.md"
 repository = "https://github.com/eclipse-volttron/volttron-listener"
 homepage = "https://github.com/eclipse-volttron/volttron-listener"
 keywords = []
-packages = [ { include = "listener", from = "src" } ]
+packages = [
+    { include = "listener", from = "src" },
+]
 classifiers = [
     "Programming Language :: Python :: 3 :: Only",
     "Intended Audience :: Science/Research",
     "Intended Audience :: Information Technology",
     "Intended Audience :: Developers",
     "Intended Audience :: Other Audience",
-    "License :: OSI Approved :: Apache Software License"
+    "License :: OSI Approved :: Apache Software License",
 ]
+
 [tool.poetry.dependencies]
 python = ">=3.10,<4.0"
-
-#volttron-core = {path="../volttron-core", develop = true}
+volttron-core = {path="../volttron-core", develop = true}
 
 [tool.poetry.group.dev.dependencies]
 volttron-testing = {path = "../volttron-testing", develop = true}
@@ -30,13 +34,16 @@ volttron-testing = {path = "../volttron-testing", develop = true}
 #volttron-lib-zmq = {path = "../volttron-lib-zmq", develop = true}
 #volttron-lib-auth = {path = "../volttron-lib-auth", develop = true}
 
+[tool.poetry.scripts]
+volttron-listener-agent = "listener.agent:main"
+
 
 [tool.yapfignore]
 ignore_patterns = [
     ".venv/**",
     ".pytest_cache/**",
     "dist/**",
-    "docs/**"
+    "docs/**",
 ]
 
 [tool.yapf]
@@ -45,9 +52,8 @@ spaces_before_comment = 4
 column_limit = 120
 split_before_logical_operator = true
 
-[tool.poetry.scripts]
-volttron-listener-agent = "listener.agent:main"
-
 [build-system]
-requires = ["poetry-core>=1.2.2"]
+requires = [
+    "poetry-core>=1.2.2",
+]
 build-backend = "poetry.core.masonry.api"