Skip to content

Installation (Unix)

Fluvio L. Lobo Fenoglietto edited this page May 23, 2019 · 7 revisions
  1. Pre-requisites

    1. Keep system up-to-date

      apt update
      apt upgrade
      
    2. Install pip

      NOTES:

      • Use bootstrap to properly install pip [1]
      • Installation may require sudo
      curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
      python get-pip.py
      
  2. Get the onshapepy module,

    python pip install onshapepy
    
  3. Place the generated API keys in the user's home directory under .onshapepy

    cd ~
    nano .onshapepy
    
    1. Use the layout specified by Onshape:

      creds:
          access_key: *******YOUR API KEY*******
          secret_key: *******YOUR API SECRET****
      
    2. Replace the *******YOUR API KEY******* and *******YOUR API SECRET**** sections with the keys retrieved from Onshape's developer portal

    3. Save file within the user directory C:\Users\<USER_NAME>\, using the filename .onshapepy.

      NOTE: Both periods on the .onshapepy. name are necessary!

  4. ENJOY!

Clone this wiki locally