Rename chip-repl to matter-repl (project-chip#40751)

* Format device node ID as hex just like in core SDK

* Rename chip-repl to matter-repl

* Properly define dependencies between matter-* packages

* Make matter-repl banner more compact

* Restyled by prettier-markdown

* Update src/controller/python/matter/ReplStartup.py

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* Update src/controller/python/matter/yaml/runner.py

Co-authored-by: Copilot <[email protected]>

* Fix markdown codeblock lexer issues

* Fix scripts/build_python_device.sh

* Install all matter packages at once

---------

Co-authored-by: Restyled.io <[email protected]>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Copilot <[email protected]>

Author: 4 people

.github/workflows/build.yaml

@@ -365,9 +365,7 @@ jobs:
                   scripts/run_in_build_env.sh 'virtualenv pyenv'
                   source pyenv/bin/activate
                   python -m ensurepip --upgrade
-                  python -m pip install ./out/controller/python/matter_core-1.0.0-cp37-abi3-linux_x86_64.whl
-                  python -m pip install ./out/controller/python/matter_clusters-1.0.0-py3-none-any.whl
-                  python -m pip install ./out/controller/python/matter_repl-1.0.0-py3-none-any.whl
+                  python -m pip install out/controller/python/matter*.whl
 
             - name: Run Python tests
               shell: bash

.github/workflows/tests.yaml

@@ -357,12 +357,12 @@ jobs:
                      --all-clusters-app ./out/linux-x64-all-clusters-${BUILD_VARIANT}/chip-all-clusters-app \
                   "
 
-            - name: Run Tests using chip-repl (skip slow)
+            - name: Run Tests using matter-repl (skip slow)
               if: github.event_name == 'pull_request'
               run: |
                   ./scripts/run_in_python_env.sh out/venv \
                   "./scripts/tests/run_test_suite.py \
-                     --runner chip_repl_python \
+                     --runner matter_repl_python \
                      --exclude-tags MANUAL \
                      --exclude-tags FLAKY \
                      --exclude-tags IN_DEVELOPMENT \
@@ -385,12 +385,12 @@ jobs:
                      --energy-gateway-app ./out/linux-x64-energy-gateway-${BUILD_VARIANT}/chip-energy-gateway-app \
                      --energy-management-app ./out/linux-x64-energy-management-${BUILD_VARIANT}/chip-energy-management-app \
                   "
-            - name: Run Tests using chip-repl (including slow)
+            - name: Run Tests using matter-repl (including slow)
               if: github.event_name == 'push'
               run: |
                   ./scripts/run_in_python_env.sh out/venv \
                   "./scripts/tests/run_test_suite.py \
-                     --runner chip_repl_python \
+                     --runner matter_repl_python \
                      run \
                      --iterations 1 \
                      --test-timeout-seconds 120 \
@@ -863,10 +863,10 @@ jobs:
                   ln -s linux-x64-all-clusters-${BUILD_VARIANT}-clang-test out/linux-x64-all-clusters
 
                   scripts/run_in_python_env.sh out/venv \
-                  "jupyter execute docs/development_controllers/chip-repl/Matter_REPL_Intro.ipynb \
-                  docs/development_controllers/chip-repl/Matter_Basic_Interactions.ipynb \
-                  docs/development_controllers/chip-repl/Matter_Access_Control.ipynb \
-                  docs/development_controllers/chip-repl/Matter_Multi_Fabric_Commissioning.ipynb \
+                  "jupyter execute docs/development_controllers/matter-repl/Matter_REPL_Intro.ipynb \
+                  docs/development_controllers/matter-repl/Matter_Basic_Interactions.ipynb \
+                  docs/development_controllers/matter-repl/Matter_Access_Control.ipynb \
+                  docs/development_controllers/matter-repl/Matter_Multi_Fabric_Commissioning.ipynb \
                   "
 
             - name: Uploading core files

BUILD.gn

@@ -132,7 +132,7 @@ if (current_toolchain != "${dir_pw_toolchain}/default:default") {
       deps = [
         "${chip_root}/scripts:matter_yamltests_distribution.wheel",
         "${chip_root}/scripts/py_matter_yamltests:matter-yamltests.wheel",
-        "${chip_root}/src/controller/python:chip-repl",
+        "${chip_root}/src/controller/python:matter-repl",
         "${chip_root}/src/python_testing/matter_testing_infrastructure:matter-testing.wheel",
         "${chip_root}/src/python_testing/post_certification_tests:matter-post-certification-tests.wheel",
       ]
@@ -244,7 +244,7 @@ if (current_toolchain != "${dir_pw_toolchain}/default:default") {
       data_deps = [ "${chip_root}/examples/chip-tool" ]
 
       if (chip_enable_python_modules) {
-        data_deps += [ "${chip_root}/src/controller/python:chip-repl" ]
+        data_deps += [ "${chip_root}/src/controller/python:matter-repl" ]
       }
 
       write_runtime_deps = "${root_out_dir}/certification.runtime_deps"

docs/development_controllers/chip-repl/index.md

@@ -5,9 +5,9 @@
 :maxdepth: 1
 :hidden:
 
-chip-repl/index
 chip-tool/index
+matter-repl/index
 ```
 
 -   [chip-tool](./chip-tool/index.md)
--   [chip-repl](./chip-repl/index.md)
+-   [matter-repl](./matter-repl/index.md)

docs/development_controllers/index.md

@@ -97,7 +97,7 @@
        "<span style=\"font-weight: bold\"> Replacing </span> store path .<span style=\"color: #800080; text-decoration-color: #800080\">/credentials/development/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">paa-root-certs</span> with \n",
        "<span style=\"color: #800080; text-decoration-color: #800080\">/home/root/repos/connectedhomeip/credentials/development/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">paa-root-certs</span>\n",
        "Note that you are still running from \n",
-       "<span style=\"color: #800080; text-decoration-color: #800080\">/home/root/repos/connectedhomeip/docs/development_controllers/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">chip-repl</span> so other relative\n",
+       "<span style=\"color: #800080; text-decoration-color: #800080\">/home/root/repos/connectedhomeip/docs/development_controllers/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">matter-repl</span> so other relative\n",
        "paths may be off.\n",
        "                    \n",
        "</pre>\n"
@@ -107,7 +107,7 @@
        "\u001b[1m Replacing \u001b[0m store path .\u001b[35m/credentials/development/\u001b[0m\u001b[95mpaa-root-certs\u001b[0m with \n",
        "\u001b[35m/home/root/repos/connectedhomeip/credentials/development/\u001b[0m\u001b[95mpaa-root-certs\u001b[0m\n",
        "Note that you are still running from \n",
-       "\u001b[35m/home/root/repos/connectedhomeip/docs/development_controllers/\u001b[0m\u001b[95mchip-repl\u001b[0m so other relative\n",
+       "\u001b[35m/home/root/repos/connectedhomeip/docs/development_controllers/\u001b[0m\u001b[95mmatter-repl\u001b[0m so other relative\n",
        "paths may be off.\n",
        "                    \n"
       ]
@@ -263,7 +263,7 @@
    "source": [
     "%reset -f\n",
     "import importlib.util\n",
-    "spec = importlib.util.find_spec('matter.ChipReplStartup')\n",
+    "spec = importlib.util.find_spec('matter.ReplStartup')\n",
     "%run {spec.origin}"
    ]
   },
@@ -360,7 +360,7 @@
    "id": "372ae9a4",
    "metadata": {},
    "source": [
-    "During Commissioning, an ACL that assigns Administer rights to the commissioner(i.e. chip-repl) was automatically installed on the commissionee."
+    "During Commissioning, an ACL that assigns Administer rights to the commissioner(i.e. matter-repl) was automatically installed on the commissionee."
    ]
   },
   {

docs/development_controllers/chip-repl/Matter_Access_Control.ipynb renamed to docs/development_controllers/matter-repl/Matter_Access_Control.ipynb

@@ -67,7 +67,7 @@
     "\n",
     "Let's first begin by setting up by importing some key modules that are needed to make it easier for us to interact with the Matter stack.\n",
     "\n",
-    "`ChipReplStartup.py` is run within the global namespace. This results in all of its imports being made available here.\n",
+    "`ReplStartup.py` is run within the global namespace. This results in all of its imports being made available here.\n",
     "\n",
     "> **NOTE**: _This is not needed if you launch the REPL from the command-line._"
    ]
@@ -87,7 +87,7 @@
        "<span style=\"font-weight: bold\"> Replacing </span> store path .<span style=\"color: #800080; text-decoration-color: #800080\">/credentials/development/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">paa-root-certs</span> with \n",
        "<span style=\"color: #800080; text-decoration-color: #800080\">/home/root/repos/connectedhomeip/credentials/development/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">paa-root-certs</span>\n",
        "Note that you are still running from \n",
-       "<span style=\"color: #800080; text-decoration-color: #800080\">/home/root/repos/connectedhomeip/docs/development_controllers/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">chip-repl</span> so other relative\n",
+       "<span style=\"color: #800080; text-decoration-color: #800080\">/home/root/repos/connectedhomeip/docs/development_controllers/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">matter-repl</span> so other relative\n",
        "paths may be off.\n",
        "                    \n",
        "</pre>\n"
@@ -97,7 +97,7 @@
        "\u001b[1m Replacing \u001b[0m store path .\u001b[35m/credentials/development/\u001b[0m\u001b[95mpaa-root-certs\u001b[0m with \n",
        "\u001b[35m/home/root/repos/connectedhomeip/credentials/development/\u001b[0m\u001b[95mpaa-root-certs\u001b[0m\n",
        "Note that you are still running from \n",
-       "\u001b[35m/home/root/repos/connectedhomeip/docs/development_controllers/\u001b[0m\u001b[95mchip-repl\u001b[0m so other relative\n",
+       "\u001b[35m/home/root/repos/connectedhomeip/docs/development_controllers/\u001b[0m\u001b[95mmatter-repl\u001b[0m so other relative\n",
        "paths may be off.\n",
        "                    \n"
       ]
@@ -253,7 +253,7 @@
    "source": [
     "%reset -f\n",
     "import importlib.util\n",
-    "spec = importlib.util.find_spec('matter.ChipReplStartup')\n",
+    "spec = importlib.util.find_spec('matter.ReplStartup')\n",
     "%run {spec.origin}"
    ]
   },

docs/development_controllers/chip-repl/Matter_Basic_Interactions.ipynb renamed to docs/development_controllers/matter-repl/Matter_Basic_Interactions.ipynb

@@ -85,7 +85,7 @@
     "\n",
     "Let's first begin setting up by importing some key modules that are needed to make it easier for us to interact with the Matter stack.\n",
     "\n",
-    "`ChipReplStartup.py` is run within the global namespace. This results in all of its imports being made available here.\n",
+    "`ReplStartup.py` is run within the global namespace. This results in all of its imports being made available here.\n",
     "\n",
     "> **NOTE**: _This is not needed if you launch the REPL from the command-line._"
    ]
@@ -106,7 +106,7 @@
        "<span style=\"font-weight: bold\"> Replacing </span> store path .<span style=\"color: #800080; text-decoration-color: #800080\">/credentials/development/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">paa-root-certs</span> with \n",
        "<span style=\"color: #800080; text-decoration-color: #800080\">/home/root/repos/connectedhomeip/credentials/development/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">paa-root-certs</span>\n",
        "Note that you are still running from \n",
-       "<span style=\"color: #800080; text-decoration-color: #800080\">/home/root/repos/connectedhomeip/docs/development_controllers/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">chip-repl</span> so other relative\n",
+       "<span style=\"color: #800080; text-decoration-color: #800080\">/home/root/repos/connectedhomeip/docs/development_controllers/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">matter-repl</span> so other relative\n",
        "paths may be off.\n",
        "                    \n",
        "</pre>\n"
@@ -116,7 +116,7 @@
        "\u001b[1m Replacing \u001b[0m store path .\u001b[35m/credentials/development/\u001b[0m\u001b[95mpaa-root-certs\u001b[0m with \n",
        "\u001b[35m/home/root/repos/connectedhomeip/credentials/development/\u001b[0m\u001b[95mpaa-root-certs\u001b[0m\n",
        "Note that you are still running from \n",
-       "\u001b[35m/home/root/repos/connectedhomeip/docs/development_controllers/\u001b[0m\u001b[95mchip-repl\u001b[0m so other relative\n",
+       "\u001b[35m/home/root/repos/connectedhomeip/docs/development_controllers/\u001b[0m\u001b[95mmatter-repl\u001b[0m so other relative\n",
        "paths may be off.\n",
        "                    \n"
       ]
@@ -272,7 +272,7 @@
    "source": [
     "%reset -f\n",
     "import importlib.util\n",
-    "spec = importlib.util.find_spec('matter.ChipReplStartup')\n",
+    "spec = importlib.util.find_spec('matter.ReplStartup')\n",
     "%run {spec.origin} --debug"
    ]
   },
@@ -798,7 +798,7 @@
        "<span style=\"font-weight: bold\"> Replacing </span> store path .<span style=\"color: #800080; text-decoration-color: #800080\">/credentials/development/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">paa-root-certs</span> with \n",
        "<span style=\"color: #800080; text-decoration-color: #800080\">/home/root/repos/connectedhomeip/credentials/development/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">paa-root-certs</span>\n",
        "Note that you are still running from \n",
-       "<span style=\"color: #800080; text-decoration-color: #800080\">/home/root/repos/connectedhomeip/docs/development_controllers/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">chip-repl</span> so other relative\n",
+       "<span style=\"color: #800080; text-decoration-color: #800080\">/home/root/repos/connectedhomeip/docs/development_controllers/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">matter-repl</span> so other relative\n",
        "paths may be off.\n",
        "                    \n",
        "</pre>\n"
@@ -808,7 +808,7 @@
        "\u001b[1m Replacing \u001b[0m store path .\u001b[35m/credentials/development/\u001b[0m\u001b[95mpaa-root-certs\u001b[0m with \n",
        "\u001b[35m/home/root/repos/connectedhomeip/credentials/development/\u001b[0m\u001b[95mpaa-root-certs\u001b[0m\n",
        "Note that you are still running from \n",
-       "\u001b[35m/home/root/repos/connectedhomeip/docs/development_controllers/\u001b[0m\u001b[95mchip-repl\u001b[0m so other relative\n",
+       "\u001b[35m/home/root/repos/connectedhomeip/docs/development_controllers/\u001b[0m\u001b[95mmatter-repl\u001b[0m so other relative\n",
        "paths may be off.\n",
        "                    \n"
       ]
@@ -934,7 +934,7 @@
    "source": [
     "%reset -f\n",
     "import importlib.util\n",
-    "spec = importlib.util.find_spec('matter.ChipReplStartup')\n",
+    "spec = importlib.util.find_spec('matter.ReplStartup')\n",
     "%run {spec.origin}"
    ]
   },

docs/development_controllers/chip-repl/Matter_Multi_Fabric_Commissioning.ipynb renamed to docs/development_controllers/matter-repl/Matter_Multi_Fabric_Commissioning.ipynb

@@ -26,7 +26,7 @@
     "\n",
     "Let's first begin by setting up by importing some key modules that are needed to make it easier for us to interact with the Matter stack.\n",
     "\n",
-    "`ChipReplStartup.py` is run within the global namespace. This results in all of its imports being made available here.\n",
+    "`ReplStartup.py` is run within the global namespace. This results in all of its imports being made available here.\n",
     "\n",
     "> **NOTE**: _This is not needed if you launch the REPL from the command-line._"
    ]
@@ -46,7 +46,7 @@
        "<span style=\"font-weight: bold\"> Replacing </span> store path .<span style=\"color: #800080; text-decoration-color: #800080\">/credentials/development/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">paa-root-certs</span> with \n",
        "<span style=\"color: #800080; text-decoration-color: #800080\">/home/root/repos/connectedhomeip/credentials/development/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">paa-root-certs</span>\n",
        "Note that you are still running from \n",
-       "<span style=\"color: #800080; text-decoration-color: #800080\">/home/root/repos/connectedhomeip/docs/development_controllers/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">chip-repl</span> so other relative\n",
+       "<span style=\"color: #800080; text-decoration-color: #800080\">/home/root/repos/connectedhomeip/docs/development_controllers/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">matter-repl</span> so other relative\n",
        "paths may be off.\n",
        "                    \n",
        "</pre>\n"
@@ -56,7 +56,7 @@
        "\u001b[1m Replacing \u001b[0m store path .\u001b[35m/credentials/development/\u001b[0m\u001b[95mpaa-root-certs\u001b[0m with \n",
        "\u001b[35m/home/root/repos/connectedhomeip/credentials/development/\u001b[0m\u001b[95mpaa-root-certs\u001b[0m\n",
        "Note that you are still running from \n",
-       "\u001b[35m/home/root/repos/connectedhomeip/docs/development_controllers/\u001b[0m\u001b[95mchip-repl\u001b[0m so other relative\n",
+       "\u001b[35m/home/root/repos/connectedhomeip/docs/development_controllers/\u001b[0m\u001b[95mmatter-repl\u001b[0m so other relative\n",
        "paths may be off.\n",
        "                    \n"
       ]
@@ -195,7 +195,7 @@
    "source": [
     "%reset -f\n",
     "import importlib.util\n",
-    "spec = importlib.util.find_spec('matter.ChipReplStartup')\n",
+    "spec = importlib.util.find_spec('matter.ReplStartup')\n",
     "%run {spec.origin}"
    ]
   },
@@ -222,7 +222,7 @@
        "<span style=\"font-weight: bold\"> Replacing </span> store path .<span style=\"color: #800080; text-decoration-color: #800080\">/credentials/development/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">paa-root-certs</span> with \n",
        "<span style=\"color: #800080; text-decoration-color: #800080\">/home/root/repos/connectedhomeip/credentials/development/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">paa-root-certs</span>\n",
        "Note that you are still running from \n",
-       "<span style=\"color: #800080; text-decoration-color: #800080\">/home/root/repos/connectedhomeip/docs/development_controllers/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">chip-repl</span> so other relative\n",
+       "<span style=\"color: #800080; text-decoration-color: #800080\">/home/root/repos/connectedhomeip/docs/development_controllers/</span><span style=\"color: #ff00ff; text-decoration-color: #ff00ff\">matter-repl</span> so other relative\n",
        "paths may be off.\n",
        "                    \n",
        "</pre>\n"
@@ -232,7 +232,7 @@
        "\u001b[1m Replacing \u001b[0m store path .\u001b[35m/credentials/development/\u001b[0m\u001b[95mpaa-root-certs\u001b[0m with \n",
        "\u001b[35m/home/root/repos/connectedhomeip/credentials/development/\u001b[0m\u001b[95mpaa-root-certs\u001b[0m\n",
        "Note that you are still running from \n",
-       "\u001b[35m/home/root/repos/connectedhomeip/docs/development_controllers/\u001b[0m\u001b[95mchip-repl\u001b[0m so other relative\n",
+       "\u001b[35m/home/root/repos/connectedhomeip/docs/development_controllers/\u001b[0m\u001b[95mmatter-repl\u001b[0m so other relative\n",
        "paths may be off.\n",
        "                    \n"
       ]
@@ -358,7 +358,7 @@
    "source": [
     "%reset -f\n",
     "import importlib.util\n",
-    "spec = importlib.util.find_spec('matter.ChipReplStartup')\n",
+    "spec = importlib.util.find_spec('matter.ReplStartup')\n",
     "%run {spec.origin} --storage-path /tmp/repl.json"
    ]
   },

docs/development_controllers/chip-repl/Matter_REPL_Intro.ipynb renamed to docs/development_controllers/matter-repl/Matter_REPL_Intro.ipynb

@@ -0,0 +1,15 @@
+# matter-repl
+
+```{toctree}
+:glob:
+:maxdepth: 1
+:hidden:
+
+*
+```
+
+-   [Matter REPL](./matter-repl.md)
+-   [Intro](https://github.com/project-chip/connectedhomeip/blob/master/docs/development_controllers/matter-repl/Matter_REPL_Intro.ipynb)
+-   [Basic interactions](https://github.com/project-chip/connectedhomeip/blob/master/docs/development_controllers/matter-repl/Matter_Basic_Interactions.ipynb)
+-   [Access Control](https://github.com/project-chip/connectedhomeip/blob/master/docs/development_controllers/matter-repl/Matter_Access_Control.ipynb)
+-   [Multi Fabric Commissioning](https://github.com/project-chip/connectedhomeip/blob/master/docs/development_controllers/matter-repl/Matter_Multi_Fabric_Commissioning.ipynb)