Installation

Install the pyRobotiqGripper python package using pip or uv.

We recommend using uv, a fast, modern Python package and project manager, but a traditional pip installation works just as well.

Using uv (recommended)

Install pyrobotiqgripper with minimal dependencies.

uv add pyrobotiqgripper

Install pyrobotiqgripper with all dependencies to have extra features like:

• Gripper command and status history accessible as a pandas table

• A CLI (Command Line Tool) to control the gripper with a mouse or a joystick.

uv add "pyrobotiqgripper[all]"

Note

uv automatically create a virtual environment in the project folder ./.venv

Note

If not already installed, follow the instructions to install uv from the official documentation: https://docs.astral.sh/uv/getting-started/installation/

Using pip

It is good practice to work in a virtual environment. Here below are instructions to create and activate virtual environment to install pyrobotiq gripper in it.

#Create a virtual environment ./.venv
python -m venv .venv

If you are on Windows use the following command to activate the virtual environment

.venv\Scripts\activate

If you are on macOS/Linux use the following command to activate the virtual environment

source .venv/bin/activate

Install pyrobotiqgripper with minimal dependencies.

# base install: gripper control only
pip install pyRobotiqGripper

Install pyrobotiqgripper with all dependencies to have extra features like: - Gripper command and status history accessible as a pandas table - A CLI (Command Line Tool) to control the gripper with a mouse or a joystick.

# or, with optional features (joystick CLI, history DataFrame helpers)
pip install "pyRobotiqGripper[all]"