Skip to content

Commit

Permalink
DOCS-3384: Add Python version requirement for module generator (#3857)
Browse files Browse the repository at this point in the history
  • Loading branch information
JessamyT authored Jan 16, 2025
1 parent 2c7e413 commit 3835721
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 1 deletion.
4 changes: 4 additions & 0 deletions docs/dev/tools/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -649,6 +649,10 @@ viam module reload [...named args]
viam module upload --version=<version> --platform=<platform> [--org-id=<org-id> | --public-namespace=<namespace>] [--module=<path to meta.json>] <module-path> --tags=<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="$"}
Expand Down
3 changes: 2 additions & 1 deletion docs/operate/get-started/other-hardware/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions docs/operate/get-started/other-hardware/hello-world-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 3835721

Please sign in to comment.