iotedgedev 3.3.4__zip → 3.3.5__zip

s/build/lib/iotedgedev/azurecli.py

@@ -148,10 +148,13 @@ class AzureCli:
                         pass
                 else:
                     err = None
+                    err_list = []
                     try:
-                        err = stderr_queue.get_nowait()
+                        while True:
+                            err_list.append(stderr_queue.get_nowait())
                     except Empty:
                         pass
+                    err = "\n".join(err_list)
                     # Avoid empty sys.excepthook errors from underlying future
                     # There is already a uAMQP issue in work for this
                     # https://github.com/Azure/azure-uamqp-python/issues/30
@@ -465,9 +468,16 @@ class AzureCli:
                 self.output.prompt(
                     "Creating IoT Hub. Please wait as this could take a few minutes to complete...")
 
-                result = self.invoke_az_cli_outproc(["iot", "hub", "create", "--name", value, "--resource-group",
-                                                     resource_group, "--sku", sku, "--query", "[].{\"IoT Hub\":name}", "--out", "table"],
-                                                    f("Could not create the IoT Hub {value} in {resource_group} with sku {sku}."), stdout_io=io, stderr_io=error_io)
+                cmd = ["iot", "hub", "create", "--name", value, "--resource-group", resource_group, "--sku", sku, "--query", "[].{\"IoT Hub\":name}", "--out", "table"]
+                if sku == "F1":
+                    cmd = cmd + ["--partition-count", "2"]
+                    # the default partition-count is 4, but F1 allows only 2
+                    # from `az iot hub create --help`:
+                    #   The partition count is the number of partitions that the IoT Hub uses to distribute messages.
+                    #   The default value is 4.
+                    # In Azure Portal the default and only value is 2.
+
+                result = self.invoke_az_cli_outproc(cmd, f("Could not create the IoT Hub {value} in {resource_group} with sku {sku}."), stdout_io=io, stderr_io=error_io)
                 if not result and error_io.getvalue():
                     self.output.error(error_io.getvalue())
                     self.output.line()

s/build/lib/iotedgedev/cli.py

@@ -3,6 +3,11 @@ import socket
 import sys
 
 import click
+import copy
+import typing as t
+
+from click import Command
+from click import Group
 from fstrings import f
 
 from .azurecli import AzureCli
@@ -19,6 +24,16 @@ from .simulator import Simulator
 from .solution import Solution
 from .utility import Utility
 
+# Extend click.Group#add_command(cmd, name) to take deprecated=bool flag by monkey patching.
+def add_command_with_deprecation(self, cmd: Command, name: t.Optional[str] = None, deprecated = False):
+    # Directly changing the deprecated flag of the cmd has side-effects on the reference source.
+    # To avoid this, copy the cmd object with deepcopy.
+    copied_command = copy.deepcopy(cmd)
+    copied_command.deprecated = deprecated
+    self.add_command(copied_command, name)
+
+Group.add_command_with_deprecation = add_command_with_deprecation
+
 CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'], max_content_width=120)
 
 output = Output()
@@ -84,14 +99,16 @@ def new(name, module, template, edge_runtime_version, group_id):
     sol = Solution(output, utility)
     sol.create(name, module, template, edge_runtime_version, group_id)
 
-
-main.add_command(new)
+main.add_command_with_deprecation(new, deprecated=True)
 
 
 @solution.command(context_settings=CONTEXT_SETTINGS,
                   help="Create a new IoT Edge solution and provision Azure resources",
                   # hack to prevent Click truncating help messages
                   short_help="Create a new IoT Edge solution and provision Azure resources")
+@click.argument("name",
+                required=False,
+                default=".")
 @click.option("--edge-runtime-version",
               "-er",
               default="1.2",
@@ -100,28 +117,22 @@ main.add_command(new)
               help="Specify the IoT Edge Runtime Version. Currently available 1.0, 1.1, 1.2")
 @add_module_options(envvars, init=True)
 @with_telemetry
-def init(module, template, group_id, edge_runtime_version):
+def init(name, module, template, group_id, edge_runtime_version):
     if edge_runtime_version is not None:
         if (str(edge_runtime_version) != "1.0" and str(edge_runtime_version) != "1.1" and str(edge_runtime_version) != "1.2"):
             output.info('-edge-runtime-version `{0}` is not valid. Currently supported versions are 1.0, 1.1, 1.2'.format(edge_runtime_version))
             sys.exit()
     utility = Utility(envvars, output)
 
-    if template == "java":
-        solcmd = "iotedgedev new . --module {0} --template {1} --edge-runtime-version {2} --group-id {3}".format(module, template, edge_runtime_version, group_id)
-    else:
-        solcmd = "iotedgedev new . --module {0} --template {1} --edge-runtime-version {2}".format(module, template, edge_runtime_version)
-    output.header(solcmd)
-    ret = utility.call_proc(solcmd.split())
+    sol = Solution(output, utility)
+    sol.create(name, module, template, edge_runtime_version, group_id)
 
-    if ret == 0:
-        azsetupcmd = "iotedgedev iothub setup --update-dotenv"
-        output.header(azsetupcmd)
-        # Had to use call_proc, because @click.invoke doesn't honor prompts
-        utility.call_proc(azsetupcmd.split())
+    azsetupcmd = "iotedgedev iothub setup --update-dotenv"
+    output.header(azsetupcmd)
+    utility.call_proc(azsetupcmd.split())
 
 
-main.add_command(init)
+main.add_command_with_deprecation(init, deprecated=True)
 
 
 @solution.command(context_settings=CONTEXT_SETTINGS, help="Push, deploy, start, monitor")
@@ -144,7 +155,7 @@ def add(name, template, group_id):
     mod.add(name, template, group_id)
 
 
-main.add_command(add)
+main.add_command_with_deprecation(add, deprecated=True)
 
 
 @solution.command(context_settings=CONTEXT_SETTINGS, help="Build the solution")
@@ -186,7 +197,7 @@ def build(ctx, push, do_deploy, template_file, platform):
         ctx.invoke(deploy)
 
 
-main.add_command(build)
+main.add_command_with_deprecation(build, deprecated=True)
 
 
 @solution.command(context_settings=CONTEXT_SETTINGS, help="Push module images to container registry")
@@ -227,7 +238,7 @@ def push(ctx, do_deploy, no_build, template_file, platform):
         ctx.invoke(deploy)
 
 
-main.add_command(push)
+main.add_command_with_deprecation(push, deprecated=True)
 
 
 @solution.command(context_settings=CONTEXT_SETTINGS, help="Deploy solution to IoT Edge device")
@@ -245,7 +256,7 @@ def deploy(manifest_file):
     edge.deploy(manifest_file)
 
 
-main.add_command(deploy)
+main.add_command_with_deprecation(deploy, deprecated=True)
 
 
 @iothub.command(
@@ -340,7 +351,7 @@ def genconfig(template_file, platform, fail_on_validation_error):
     mod.build_push(template_file, platform, no_build=True, no_push=True, fail_on_validation_error=fail_on_validation_error)
 
 
-main.add_command(genconfig)
+main.add_command_with_deprecation(genconfig, deprecated=True)
 
 
 @simulator.command(context_settings=CONTEXT_SETTINGS,
@@ -363,7 +374,7 @@ def setup_simulator(gateway_host, iothub_connection_string):
     sim.setup(gateway_host, iothub_connection_string)
 
 
-main.add_command(setup_simulator)
+main.add_command_with_deprecation(setup_simulator, deprecated=True)
 
 
 @simulator.command(context_settings=CONTEXT_SETTINGS,
@@ -438,7 +449,7 @@ def start_simulator(setup, solution, build, manifest_file, platform, verbose, in
         sim.start_single(inputs, port)
 
 
-main.add_command(start_simulator)
+main.add_command_with_deprecation(start_simulator, deprecated=True)
 
 
 @simulator.command(context_settings=CONTEXT_SETTINGS,
@@ -450,7 +461,7 @@ def stop_simulator():
     sim.stop()
 
 
-main.add_command(stop_simulator)
+main.add_command_with_deprecation(stop_simulator, deprecated=True)
 
 
 @simulator.command(context_settings=CONTEXT_SETTINGS,
@@ -490,7 +501,7 @@ def monitor(timeout):
     ih.monitor_events(timeout)
 
 
-main.add_command(monitor)
+main.add_command_with_deprecation(monitor, deprecated=True)
 
 
 def ensure_azure_cli_iot_ext():
@@ -824,7 +835,7 @@ def log(show, save):
     dock.handle_logs_cmd(show, save)
 
 
-main.add_command(log)
+main.add_command_with_deprecation(log, deprecated=True)
 
 if __name__ == "__main__":
     main()

s/build/lib/iotedgedev/connectionstring.py

@@ -2,8 +2,8 @@ from .utility import Utility
 
 
 class ConnectionString:
-    def __init__(self, value):
-        self.connection_string = value
+    def __init__(self, connection_string: str):
+        self.connection_string = connection_string
         self.data = dict()
 
         if self.connection_string:
@@ -22,25 +22,27 @@ class ConnectionString:
                 else:
                     # unexpected input of connection. Set to None and throw error
                     self.connection_string = None
-               
+
     def __getitem__(self, key):
         return self.data[key]
 
 
 class IoTHubConnectionString(ConnectionString):
-    def __init__(self, value):
-        ConnectionString.__init__(self, value)
+    def __init__(self, connection_string: str):
+        super().__init__(connection_string)
 
         if self.connection_string:
             self.shared_access_key_name = self["sharedaccesskeyname"]
 
 
 class DeviceConnectionString(ConnectionString):
-    def __init__(self, value):
-        ConnectionString.__init__(self, value)
+    def __init__(self, connection_string: str):
+        super().__init__(connection_string)
 
-        if self.connection_string:
+        if("deviceid" in self.data):
             self.device_id = self["deviceid"]
+        else:
+            self.device_id = None
 
 
 class IoTHubHost:

s/build/lib/iotedgedev/edge.py

@@ -14,7 +14,7 @@ class Edge:
         self.output.header("DEPLOYING CONFIGURATION")
 
         self.envvars.verify_envvar_has_val("IOTHUB_CONNECTION_STRING", self.envvars.IOTHUB_CONNECTION_INFO)
-        self.envvars.verify_envvar_has_val("DEVICE_CONNECTION_STRING", self.envvars.DEVICE_CONNECTION_INFO)
+        self.envvars.verify_envvar_has_val("EDGE_DEVICE_ID", self.envvars.DEVICE_CONNECTION_INFO.device_id)
         self.envvars.verify_envvar_has_val("DEPLOYMENT_CONFIG_FILE", self.envvars.DEPLOYMENT_CONFIG_FILE)
 
         if self.azure_cli.set_modules(config=manifest_file,

s/docker/tool/build-docker.sh

@@ -15,7 +15,7 @@ fi
 
 # read IoTEdgeDev version from python __init__ file
 
-export VERSION=$(cat ../../iotedgedev/__init__.py | grep '__version__' | grep -oP "'\K[^']+")
+export VERSION=$(cat ../../iotedgedev/__init__.py | grep '__version__' | awk '{print $3}' | sed "s;';;g")
 
 IMAGE_NAME="$1"
 PLATFORM="$2"
@@ -27,7 +27,7 @@ if [ "$IMAGE_NAME" = "--help" ]; then
 fi
 
 PYTHON2="2.7.14" #TODO READ FROM deps.txt
-PYTHON3="3.6.6"
+PYTHON3="3.9.12"
 
 build_linux=1
 build_windows=1
@@ -165,4 +165,4 @@ fi
 
 if [ in_docker_folder = 0 ]; then
     cd original_folder
-fi
+fi

s/docker/tool/deps.txt

@@ -1,5 +1,5 @@
 PYTHON2_VERSION=2.7.14
-PYTHON3_VERSION=3.6.5
+PYTHON3_VERSION=3.9.12
 NODEJS_VERSION=8.11.1
 DOTNETCORESDK_VERSION=2.1.4
 DOCKER_VERSION=17.09.0

s/docker/tool/linux/Dockerfile.base

@@ -1,4 +1,4 @@
-FROM ubuntu:18.04
+FROM mcr.microsoft.com/mirror/docker/library/ubuntu:20.04
 ENV DEBIAN_FRONTEND noninteractive
 ENV DOTNETCORESDK_VERSION 2.1
 ENV DOCKER_COMPOSE_VERSION 1.22.0
@@ -9,7 +9,7 @@ RUN apt-get update && apt-get install -y apt-transport-https ca-certificates cur
     apt-get update && \
     apt-get install -y docker-ce
 RUN apt-get install git gnupg gnupg2 gnupg1 -y && \
-    apt-get install -y --no-install-recommends dialog apt-utils curl apt-transport-https python-pip python3-pip libltdl-dev && \ 
+    apt-get install -y --no-install-recommends dialog apt-utils curl apt-transport-https python3-pip libltdl-dev && \ 
     curl -sL https://deb.nodesource.com/setup_14.x | bash - && \
     apt-get install -y nodejs
 RUN apt-get install -y wget && \
@@ -27,7 +27,10 @@ RUN apt-get update && \
     npm i npm@latest -g && \
     npm i -g azure-iothub yo generator-azure-iot-edge-module && \
     apt-get install -y --no-install-recommends python-dev build-essential libssl-dev libffi-dev libxml2-dev libxslt1-dev zlib1g-dev sudo
-RUN python3 -m pip install --upgrade pip && \
+RUN apt install python3.9 -y && \
+    rm /usr/bin/python3 && \
+    ln -s /usr/bin/python3.9 /usr/bin/python3 && \
+    python3 -m pip install --upgrade pip && \
     pip3 install setuptools && \
     pip3 install cookiecutter
 RUN apt-get -y install openjdk-8-jdk
@@ -58,4 +61,4 @@ USER iotedgedev
 RUN az extension add --name azure-iot && \
     echo 'alias python=python3' >> ~/.bashrc && \
     echo 'alias pip=pip3' >> ~/.bashrc
-ENV DEBIAN_FRONTEND teletype
+ENV DEBIAN_FRONTEND teletype

s/docker/tool/windows/Dockerfile.base

@@ -1,4 +1,4 @@
-FROM microsoft/windowsservercore:1709 AS base
+FROM mcr.microsoft.com/windows/servercore:1709 AS base
 SHELL ["powershell", "-Command", "$ErrorActionPreference = 'Stop'; $ProgressPreference = 'SilentlyContinue';"]
 ARG PYTHON2_VERSION
 ARG PYTHON3_VERSION

s/docs/_Sidebar.md

@@ -1,13 +1,14 @@
 * [Home](home)
 * Dev Machine Setup
-    * [Quickstart with IoT Edge Dev Container](quickstart-with-iot-edge-dev-container)
-    * [Manual Setup](manual-dev-machine-setup)
+  * [Quickstart](quickstart)
+  * [Manual Setup](environment-setup/manual-dev-machine-setup)
 * [Azure Setup](azure-setup)
 * [Edge Device Setup](edge-device-setup)
 * [Command List](command-list)
-* [Python Virtual Environment Setup](python-virtual-environment-setup)
+* [Command Tips](command-tips)
+* [Python Virtual Environment Setup](environment-setup/python-virtual-environment-setup)
 * [Test Coverage](test-coverage)
 * [Troubleshooting](troubleshooting)
 * [Contributing](https://github.com/Azure/iotedgedev/blob/main/CONTRIBUTING.md)
 * Misc
-    * [Migration Guides for Public Preview Users](migration-guides)
+  * [Migration Guides for Public Preview Users](migration-guides)

s/docs/{Azure-Setup.md → azure-setup.md}

@@ -1,4 +1,4 @@
-#### Automated Setup
+## Automated Setup
 
 The following will show you how to setup your Azure Resources via the CLI instead of using the Portal.
 
@@ -16,7 +16,7 @@ Here are all the `iotedgedev iothub setup` command options:
 
 > You can override all of these parameters with environment variables. Please see the .env file in your solution for details.
 
-```
+```sh
 iotedgedev iothub setup
     --credentials USERNAME PASSWORD
     --service-principal USERNAME PASSWORD TENANT
@@ -31,7 +31,7 @@ iotedgedev iothub setup
 
 You can use the following `az cli` command to create a service principal:
 
-```
+```sh
 az ad sp create-for-rbac -n "iotedgedev01"
 ```
 
@@ -39,17 +39,17 @@ az ad sp create-for-rbac -n "iotedgedev01"
 
 Alternatively, you can deploy the IoT Hub **and** Container Registry with this **Deploy to Azure** template:
 
-[![Azure Deployment](https://azuredeploy.net/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fazure%2Fiotedgedev%2Fmaster%2Fassets%2Fdeploy%2FARMDeployment%2Fazuredeploy.json)
+[![Deploy to Azure Button](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fazure%2Fiotedgedev%2Fmain%2Fassets%2Fdeploy%2FARMDeployment%2Fazuredeploy.json)
 
 > Note: If you do not need a Container Registry, or are planning to use a local registry, then you should run the **iotedgedev iothub setup** command instead of running this **Deploy to Azure** template, because the template includes a Container Registry.
 
-#### Manual Setup
-1. [**Create Azure IoT Hub**](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-csharp-csharp-getstarted#create-an-iot-hub)
-1. **Create Edge Device** using the Azure Portal
-    - In your IoT Hub, click "IoT Edge", then click "Add IoT Edge Device"
+## Manual Setup
 
-1.  **Container Registry**
-    When you develop for IoT Edge, you need to host your images in a container registry, which the IoT Edge runtime will fetch the modules images from when it starts. 
+1. [**Create Azure IoT Hub**](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-csharp-csharp-getstarted#create-an-iot-hub)
+2. **Create Edge Device** using the Azure Portal
+   - In your IoT Hub, click "IoT Edge", then click "Add IoT Edge Device"
+3. **Container Registry**
+    When you develop for IoT Edge, you need to host your images in a container registry, which the IoT Edge runtime will fetch the modules images from when it starts.
 
     > By default, the IoT Edge Dev Tool will use the Local Registry.
 
@@ -59,35 +59,36 @@ Alternatively, you can deploy the IoT Hub **and** Container Registry with this *
 
         Set `CONTAINER_REGISTRY_SERVER` to `localhost:5000` and leave `CONTAINER_REGISTRY_USERNAME` and `CONTAINER_REGISTRY_PASSWORD` blank.
 
-        ```
+        ```sh
         CONTAINER_REGISTRY_SERVER="localhost:5000"
         ```
 
-    1. Azure Container Registry
+    2. Azure Container Registry
 
         You can create an [**Azure Container Registry**](https://docs.microsoft.com/en-us/azure/container-registry/container-registry-get-started-portal) and host your images there.
             - Make sure you enable Admin Access when you create the Azure Container Registry
 
         After created, open .env and set the following:
 
-        ```
+        ```sh
         CONTAINER_REGISTRY_SERVER="ACR URI" 
         CONTAINER_REGISTRY_USERNAME="ACR USERNAME"
         CONTAINER_REGISTRY_PASSWORD="ACR PASSWORD"
         ```
 
         Example:
-        ```
+
+        ```sh
         CONTAINER_REGISTRY_SERVER="jong.azurecr.io" 
         CONTAINER_REGISTRY_USERNAME="jong"
         CONTAINER_REGISTRY_PASSWORD="p@$$w0rd"
         ```
 
-    1. Docker Hub
+    3. Docker Hub
 
         You can also host your images on Docker Hub. Create a Docker Hub account and then open .env and enter the following:
 
-        ```
+        ```sh
         CONTAINER_REGISTRY_SERVER="DOCKER HUB USERNAME" 
         CONTAINER_REGISTRY_USERNAME="DOCKER HUB USERNAME"
         CONTAINER_REGISTRY_PASSWORD="DOCKER HUB PASSWORD"
@@ -95,8 +96,8 @@ Alternatively, you can deploy the IoT Hub **and** Container Registry with this *
 
         Example:
 
-        ```
+        ```sh
         CONTAINER_REGISTRY_SERVER="jongallant" 
         CONTAINER_REGISTRY_USERNAME="jongallant"
         CONTAINER_REGISTRY_PASSWORD="p@$$w0rd"
-        ```
+        ```

s/docs/{Edge-Device-Setup.md → edge-device-setup.md}

@@ -7,17 +7,18 @@ IoT Edge Dev Tool is intended to help with IoT Edge development and doesn't nece
 
 Having said that, there's nothing stopping you from deploying IoT Edge Dev Tool to your IoT Edge device. It may be helpful if you want to run the `iotedgedev docker clean` command to clean up Docker containers and images. Or if you want to run `iotedgedev docker log --show` to see all the log files on the device or `iotedgedev docker log --save` to output to the LOGS_PATH directory.
 
-> Please note that you will need .NET Core SDK 2.1 to add C# modules and C# Function modules on a Raspberry Pi. Check [Manual Dev Machine Setup](manual-dev-machine-setup#c-module-and-c-azure-functions-module) to learn how to install.
+> Please note that you will need .NET Core SDK 2.1 to add C# modules and C# Function modules on a Raspberry Pi. Check [Manual Dev Machine Setup](environment-setup/manual-dev-machine-setup) to learn how to install.
 
 ### Raspberry Pi
 
-##### Config Changes
+#### Config Changes
+
 If you are running on Raspberry Pi you need to use the arm32v7 Dockerfile. Open `deployment.template.json`, find the JSON dictionary for `filtermodule`, and replace `"image": "${MODULES.filtermodule.amd64}",` with `"image": "${MODULES.filtermodule.arm32v7}",`
 
-##### Environment Variable Change
+#### Environment Variable Change
 
 Open your `.env` file and add `arm32v7` to your `ACTIVE_DOCKER_PLATFORMS` setting. This will tell the IoT Edge Dev Tool to also build the arm32v7 images.
 
-```
+```sh
 ACTIVE_DOCKER_PLATFORMS="amd64,arm32v7"
 ```

s/docs/environment-setup/install-docker.md

@@ -0,0 +1,9 @@
+# Install [Docker CE](https://docs.docker.com/install/)
+
+- Windows
+  - Be sure to check whether you are running in Linux container mode or Windows container mode.
+- Linux
+  - We've seen some issues with docker.io. If Edge doesn't run for you, then try installing Docker CE directly instead of via docker.io. Use the [CE install steps](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/#install-docker-ce), or use the [convenience script](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/#install-using-the-convenience-script).
+  - By default, you need `sudo` to run `docker` commands. If you want to avoid this, please follow the [post-installation steps for Linux](https://docs.docker.com/install/linux/linux-postinstall/#manage-docker-as-a-non-root-user).
+
+Note: If the device is behind the proxy server, you can set the [proxy manually](https://docs.docker.com/network/proxy/#configure-the-docker-client).

s/docs/environment-setup/manual-dev-machine-setup.md

@@ -0,0 +1,79 @@
+Here is what you need to do to get Azure IoT Edge Dev Tool (aka `iotedgedev`) running on your dev machine manually instead of using the IoT Edge Dev Container.
+
+If you are using a separate Edge device, like a Raspberry Pi, you do not need to run all of these steps on your IoT Edge device, you can install and setup Edge runtime directly on the device. See the [Edge Device Setup](edge-device-setup) wiki page for more information on setting up your Edge device.
+
+> Note: See the ["Test Coverage"](test-coverage) wiki page to see what the IoT Edge Dev Tool has been tested with.
+
+1. Install **Python 2.7+ or Python 3.6+** and **pip** (Python 3.6 is recommended)
+    - Windows: [Install from Python's website](https://www.python.org/downloads/)
+    - Linux: `sudo apt install python-pip` or `sudo apt install python3-pip`
+    - macOS: The OpenSSL used by the system built-in Python is old and vulnerable. Please use Python installed with [Homebrew](https://docs.brew.sh/Homebrew-and-Python)
+
+2. Install **[Azure CLI 2.0](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest)**
+
+3. Install **[Azure CLI IoT extension](https://github.com/Azure/azure-iot-cli-extension/)**
+
+    - New Install: `az extension add --name azure-iot`
+    - Update Install: `az extension update --name azure-iot`
+
+4. (Python < 3.5 only) Install **[Node.js](https://nodejs.org/en/download/)** and the **`iothub-explorer`** package
+
+    - uamqp, which is needed by Azure CLI IoT extension for monitoring messages, is not supported in Python < 3.5. For Python < 3.5 users, please install [Node.js](https://nodejs.org/en/download/) and the `iothub-explorer` Node.js package: `npm i -g iothub-explorer`
+
+5. (Raspberry Pi only) Install extra system dependencies
+
+    ```sh
+    sudo apt-get install python2.7-dev libffi-dev libssl-dev -y
+    ```
+
+6. (Linux only) Install [Docker Compose](https://docs.docker.com/compose/)
+
+    ```sh
+    pip install -U docker-compose
+    ```
+
+7. Install **`iotedgedev`**
+
+    > You do not need to do this if you're going to be developing on iotedgedev
+
+    > You do not need to run this on the Edge device. See the [Edge Device Setup](edge-device-setup) page for more information on setting up your Edge device.
+
+    > You can also run under a Python Virtual Environment.  See the [Python Virtual Environment Setup](python-virtual-environment-setup) instructions page for details on how to set that up.
+
+    > There is a known dependency conflict between `iotedgedev` and now-deprecated `azure-iot-edge-runtime-ctl`. Please make sure you have uninstalled `azure-iot-edge-runtime-ctl` before installing `iotedgedev`: `pip uninstall azure-iot-edge-runtime-ctl`, or use a clean virtual environment.
+
+    ```sh
+    pip install -U iotedgedev
+    ```
+
+8. Install module dependencies
+
+    - **C# module and C# Azure Functions module**
+
+        Install **[.NET Core SDK 2.1 or later](https://www.microsoft.com/net/download)**
+        > You need .NET Core SDK 2.1 or later to run it on ARM. There is no official document on installing .NET Core SDK on ARM yet, but you can follow the [ARM32v7 Dockerfile](https://github.com/dotnet/dotnet-docker/blob/master/src/sdk/3.1/buster/arm32v7/Dockerfile).
+
+    - **Python module**
+
+      1. Install **[Git](https://git-scm.com/)**
+      2. Install **[Cookiecutter](https://github.com/audreyr/cookiecutter)**
+
+      ```sh
+      pip install -U cookiecutter
+      ```
+
+    - **Node.js module**
+
+      1. Install **[Node.js](https://nodejs.org/en/download/)**
+      2. Install **[Yeoman](http://yeoman.io/)** and **[Azure IoT Edge Node.js module generator](https://github.com/Azure/generator-azure-iot-edge-module)** packages
+
+      ```sh
+      npm i -g yo generator-azure-iot-edge-module
+      ```
+
+    - **Java module**
+
+      1. Install **[JDK](https://www.oracle.com/technetwork/java/javase/downloads/index.html)**
+      2. Install **[Maven](https://maven.apache.org/)**
+
+9. Follow the [Usage Wiki](usage) to learn the usage of IoT Edge Dev Tool

s/docs/{Python-Virtual-Environment-Setup.md → environment-setup/python-virtual-environment-setup.md}

@@ -4,18 +4,17 @@ You can run IoT Edge Dev Tool inside a [Python Virtual Environment](https://docs
 
     `pip install virtualenv`
 
-1. Create a virtual environment
+2. Create a virtual environment
 
     `virtualenv venv`
 
     > `venv` is just a env name that can be anything you want, but we recommend sticking with `venv` if you want to contribute to IoT Edge Dev Tool because the `.gitignore` file excludes it.
 
     > To create a virtual environment with a Python version different with your system default, just use the `--python/-p` option to specify the Python executable path, *e.g.*:
-    > ```
-    > virtualenv --python /usr/bin/python2.7 py27
-    > ```
+    >
+    > `virtualenv --python /usr/bin/python2.7 py27`
 
-1. Activate the virtual environment
+3. Activate the virtual environment
 
     - Windows
         - cmd.exe: `venv\Scripts\activate.bat`
@@ -24,11 +23,11 @@ You can run IoT Edge Dev Tool inside a [Python Virtual Environment](https://docs
     - Posix: `source venv/bin/activate`
     > It will be active until you deactivate it or close the terminal instance.
 
-1. Install dependencies
+4. Install dependencies
 
-    Continue with the instructions above starting with the [Manual Dev Machine Setup](manual-dev-machine-setup) -> Install Dependencies.
+    Continue with the instructions above starting with the [Manual Dev Machine Setup](Environment-Setup/manual-dev-machine-setup) -> Install Dependencies.
 
-1. Deactivate the virtual environment
+5. Deactivate the virtual environment
 
     When you are done with your virtualenv, you can deactivate it with the follow command:
 

s/docs/environment-setup/run-devcontainer-docker.md

@@ -0,0 +1,24 @@
+# Run the IoT Edge Dev Container with Docker
+
+Before you run the container, you will need to create a local folder to store your IoT Edge solution files.
+
+## Windows
+
+```cmd
+mkdir c:\temp\iotedge
+docker run -ti -v /var/run/docker.sock:/var/run/docker.sock -v c:/temp/iotedge:/home/iotedge mcr.microsoft.com/iotedge/iotedgedev
+```
+
+## Linux
+
+```bash
+sudo mkdir /home/iotedge
+sudo docker run -ti -v /var/run/docker.sock:/var/run/docker.sock -v ~/iotedge:/home/iotedge mcr.microsoft.com/iotedge/iotedgedev
+```
+
+## macOS
+
+```bash
+mkdir ~/iotedge
+docker run -ti -v /var/run/docker.sock:/var/run/docker.sock -v ~/iotedge:/home/iotedge mcr.microsoft.com/iotedge/iotedgedev
+```

s/docs/home.md

@@ -0,0 +1,10 @@
+Welcome to the IoT Edge Dev Tool wiki!
+
+The **IoT Edge Dev Tool** greatly simplifies [Azure IoT Edge](https:/azure.microsoft.com/en-us/services/iot-edge/) development down to simple commands driven by environment variables.
+
+- It gets you started with IoT Edge development with the [IoT Edge Dev Container](quickstart) and IoT Edge solution scaffolding that contains a default module and all the required configuration files.
+- It speeds up your inner-loop dev (dev, debug, test) by reducing multi-step build & deploy processes into one-line CLI commands as well as drives your outer-loop CI/CD pipeline. _You can use all the same commands in both stages of your development life-cycle._
+
+## Issues
+
+Please use the [GitHub issues page](https://github.com/azure/iotedgedev/issues) to report any issues.