diff --git a/docs/dev/tools/cli.md b/docs/dev/tools/cli.md index 01000eb6ed..48dfbed7c7 100644 --- a/docs/dev/tools/cli.md +++ b/docs/dev/tools/cli.md @@ -649,6 +649,10 @@ viam module reload [...named args] viam module upload --version= --platform= [--org-id= | --public-namespace=] [--module=] --tags= ``` +{{% alert title="Note" color="note" %}} +If you are writing your module using Python, you must have Python version 3.11 or newer installed on your computer for the `viam module generate` command to work. +{{% /alert %}} + Examples: ```sh {class="command-line" data-prompt="$"} diff --git a/docs/operate/get-started/other-hardware/_index.md b/docs/operate/get-started/other-hardware/_index.md index 5278725041..903ff681e8 100644 --- a/docs/operate/get-started/other-hardware/_index.md +++ b/docs/operate/get-started/other-hardware/_index.md @@ -88,7 +88,8 @@ Authenticate your CLI session with Viam using one of the following options: {{< readfile "/static/include/how-to/auth-cli.md" >}} {{< /expand >}} -1. Run the `module generate` command in your terminal: +1. Run the `module generate` command in your terminal. + If you are writing your module using Python, you must have Python version 3.11 or newer installed on your computer for this command to work: ```sh {id="terminal-prompt" class="command-line" data-prompt="$"} viam module generate diff --git a/docs/operate/get-started/other-hardware/hello-world-module.md b/docs/operate/get-started/other-hardware/hello-world-module.md index 411171c13e..c494332a42 100644 --- a/docs/operate/get-started/other-hardware/hello-world-module.md +++ b/docs/operate/get-started/other-hardware/hello-world-module.md @@ -40,6 +40,12 @@ Authenticate your CLI session with Viam using one of the following options: {{% snippet "setup.md" %}} {{% /expand%}} +{{< expand "For Python users: Make sure you have at least Python 3.11" >}} + +If you plan to write your module using Python, you need Python version 3.11 or newer installed on your computer to use the code generation tool in this guide. +You can check by running `python3 --version` or `python --version` in your terminal. + +{{< /expand >}} ## Create a test script