From 5b4f5a00eca846aac5075e5412873191d061e0cf Mon Sep 17 00:00:00 2001 From: glannuzel Date: Thu, 11 Apr 2024 13:48:37 +0200 Subject: [PATCH] Install Python SDK --- content/sdk/getting-started/install.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/content/sdk/getting-started/install.md b/content/sdk/getting-started/install.md index ab0298c4..def5ac61 100644 --- a/content/sdk/getting-started/install.md +++ b/content/sdk/getting-started/install.md @@ -13,29 +13,32 @@ weight: "20" ## How to install the Python SDK -The Python SDK is a pure Python library. The installation should thus be rather straightforward. It supports Python >= 3.10 (older versions will not work because of typing syntax). It works on Windows/Mac/Linux. +The Python SDK is a pure Python library. The installation should thus be rather straightforward. + +It supports Python >= 3.10 (older versions will not work because of typing syntax). It works on Windows/Mac/Linux. We recommend to use [virtual environment](https://docs.python.org/3/tutorial/venv.html) for your development. They make the installation simple and avoid compatibility issues. They also come with their [pip](https://pip.pypa.io/en/stable/) command. ### From PyPi ```bash -pip3 install reachy-sdk +pip install reachy2-sdk ``` ### From the source ```bash -git clone https://github.com/pollen-robotics/reachy-sdk -pip3 install -e reachy-sdk +git clone https://github.com/pollen-robotics/reachy2-sdk +cd reachy2-sdk +pip install -e reachy2-sdk ``` ## Dependencies -The SDK relies on a few third-party Python packages: +The SDK relies on a few third-party Python packages, such as: * [numpy](https://numpy.org) - mostly for trajectory computation * [opencv](https://opencv.org) - for camera frame access * [grpc](https://grpc.io) - to connect to the robot -They will be installed automatically when you install the SDK. +They will be **installed automatically** when you install the SDK.