Installation & requirements

Requirements

You will need an Onshape account and Python 3.

Installation

Pipx is the recommended way to install Onshape URDF Exporter. Just run the following command:

pipx install onshape-urdf-exporter

Setting up your API key

To authenticate the tool with Onshape, you will need to obtain an API key and secret from the Onshape developer portal.

These keys are provided to the tool using environment variables. Declare them in your .bashrc (or shell equivalent) by adding these lines:

# Obtained at https://dev-portal.onshape.com/keys
export ONSHAPE_API=https://cad.onshape.com
export ONSHAPE_ACCESS_KEY=Your_Access_Key
export ONSHAPE_SECRET_KEY=Your_Secret_Key