search

onshape-public / onshape-clients

All Onshape clients for interacting with the Onshape API.
MIT License
34 stars 29 forks source link

readme

Onshape Clients Build Status PyPI version

NOTE This repo is in beta status and is still under development. If you run into any issues, feel free to submit an issue here tab on this repo.

This repo is responsible for generating and disseminating Onshape clients in multiple languages. These clients are for use by Onshape developer partners. To learn more, visit the Onshape Developer Portal.

Authentication

All clients use the same authentication mechanism, read by default from ~/.onshape_client_config.yaml. To add your credentials, copy .onshape_client_config.yaml to your home directory and fill in you own api key credentials from the Onshape Developer Portal.

Install

The install steps are different for each client. Navigate to the root directory of the client, and follow the README posted there. Most likely, you'll want to download the client from a specific distribution channel. For instance, if using Python, you should install the client from pypa.

Commit

We use Commitizen and semantic-release to bump versions and publish all the packages to the various package distributors.

  1. To get started, install our mono-repo dependencies with: npm install --dev
  2. Make your changes
  3. Commit changes with git cz instead of git commit. This should bring you through a step-by-step process for making your structured commit message. Once pushed, our CI will analyze the commit, and make and publish the necessary releases according to semantic-release principles.