Renaming onshape-api to onshape-robotics-toolkit.

.devcontainer/devcontainer.json

@@ -1,7 +1,7 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the
 // README at: https://github.com/devcontainers/templates/tree/main/src/python
 {
-    "name": "onshape-api",
+    "name": "onshape-robotics-toolkit",
     // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
     "image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
     "features": {
@@ -19,8 +19,8 @@
                 "python.testing.pytestArgs": ["tests"],
                 "python.testing.unittestEnabled": false,
                 "python.testing.pytestEnabled": true,
-                "python.defaultInterpreterPath": "/workspaces/onshape-api/.venv/bin/python",
-                "python.testing.pytestPath": "/workspaces/onshape-api/.venv/bin/pytest"
+                "python.defaultInterpreterPath": "/workspaces/onshape-robotics-toolkit/.venv/bin/python",
+                "python.testing.pytestPath": "/workspaces/onshape-robotics-toolkit/.venv/bin/pytest"
             }
         }
     }

.gitignore

@@ -166,12 +166,12 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 
-onshape_api/**/*.urdf
-onshape_api/**/*.stl
-onshape_api/**/*.png
-onshape_api/**/*.prof
-onshape_api/**/*.json
-onshape_api/**/*.xml
+onshape_robotics_toolkit/**/*.urdf
+onshape_robotics_toolkit/**/*.stl
+onshape_robotics_toolkit/**/*.png
+onshape_robotics_toolkit/**/*.prof
+onshape_robotics_toolkit/**/*.json
+onshape_robotics_toolkit/**/*.xml
 
 examples/**/*.urdf
 examples/**/*.stl
@@ -180,8 +180,8 @@ examples/**/*.prof
 examples/**/*.json
 examples/**/*.xml
 
-onshape_api/data/**/*.json
-onshape_api/data/**/*.parquet
+onshape_robotics_toolkit/data/**/*.json
+onshape_robotics_toolkit/data/**/*.parquet
 
 benchmark/**/*.urdf
 benchmark/**/*.stl

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to `onshape-api`
+# Contributing to `onshape-robotics-toolkit`
 
 Contributions are welcome, and they are greatly appreciated!
 Every little bit helps, and credit will always be given.
@@ -9,7 +9,7 @@ You can contribute in many ways:
 
 ## Report Bugs
 
-Report bugs at https://github.com/senthurayyappan/onshape-api/issues
+Report bugs at https://github.com/senthurayyappan/onshape-robotics-toolkit/issues
 
 If you are reporting a bug, please include:
 
@@ -33,7 +33,7 @@ Cookiecutter PyPackage could always use more documentation, whether as part of t
 
 ## Submit Feedback
 
-The best way to send feedback is to file an issue at https://github.com/senthurayyappan/onshape-api/issues.
+The best way to send feedback is to file an issue at https://github.com/senthurayyappan/onshape-robotics-toolkit/issues.
 
 If you are proposing a new feature:
 
@@ -44,22 +44,22 @@ If you are proposing a new feature:
 
 # Get Started!
 
-Ready to contribute? Here's how to set up `onshape-api` for local development.
+Ready to contribute? Here's how to set up `onshape-robotics-toolkit` for local development.
 Please note this documentation assumes you already have `poetry` and `Git` installed and ready to go.
 
-1. Fork the `onshape-api` repo on GitHub.
+1. Fork the `onshape-robotics-toolkit` repo on GitHub.
 
 2. Clone your fork locally:
 
 ```bash
 cd <directory_in_which_repo_should_be_created>
-git clone git@github.com:YOUR_NAME/onshape-api.git
+git clone git@github.com:YOUR_NAME/onshape-robotics-toolkit.git
 ```
 
 3. Now we need to install the environment. Navigate into the directory
 
 ```bash
-cd onshape-api
+cd onshape-robotics-toolkit
 ```
 
 If you are using `pyenv`, select a version to use locally. (See installed versions with `pyenv versions`)

Dockerfile

@@ -16,6 +16,6 @@ COPY poetry.lock pyproject.toml /code/
 RUN poetry install --no-interaction --no-ansi --no-root --no-dev
 
 # Copy Python code to the Docker image
-COPY onshape_api /code/onshape_api/
+COPY onshape_robotics_toolkit /code/onshape_robotics_toolkit/
 
-CMD [ "python", "onshape_api/foo.py"]
+CMD [ "python", "onshape_robotics_toolkit/foo.py"]

README.md

@@ -1,21 +1,21 @@
-# onshape-api
+# onshape-robotics-toolkit
 
-`onshape-api` is a feature-rich Python library that significantly extends the capabilities of Onshape's web-based CAD platform. The library provides a comprehensive API for automating robot design tasks, including solid model manipulation, robot assembly management, graph-based visualizations, and exporting CAD assemblies to URDF files for simulation and control. Intended as a resource for the robotics community, this library leverages Onshape's REST API to facilitate advanced workflows that bridge CAD design and robotics applications.
+`onshape-robotics-toolkit` is a feature-rich Python library that significantly extends the capabilities of Onshape's web-based CAD platform. The library provides a comprehensive API for automating robot design tasks, including solid model manipulation, robot assembly management, graph-based visualizations, and exporting CAD assemblies to URDF files for simulation and control. Intended as a resource for the robotics community, this library leverages Onshape's REST API to facilitate advanced workflows that bridge CAD design and robotics applications.
 
 <img src="docs\tutorials\export\export-header.gif" alt="Header" style="width: 100%;">
 
 &nbsp;
-This library was inspired by <a href="https://github.com/Rhoban/onshape-to-robot" target="_blank">onshape-to-robot</a>, a tool renowned for its streamlined approach to URDF generation. While onshape-to-robot library focuses on predefined workflows and design-time considerations, the `onshape-api` library offers greater flexibility. It provides access to nearly all of Onshape's REST API calls, enabling headless manipulation, detailed analysis, and seamless export of CAD assemblies. Users can programmatically edit variable studios, generate graph-based visualizations, and export URDF files tailored to their specific needs—all without being restricted by rigid workflows or naming conventions. By removing these constraints, the `onshape-api` library empowers the robotics and CAD communities to create custom solutions for algorithmic design, optimization, and automation.
+This library was inspired by <a href="https://github.com/Rhoban/onshape-to-robot" target="_blank">onshape-to-robot</a>, a tool renowned for its streamlined approach to URDF generation. While onshape-to-robot library focuses on predefined workflows and design-time considerations, the `onshape-robotics-toolkit` library offers greater flexibility. It provides access to nearly all of Onshape's REST API calls, enabling headless manipulation, detailed analysis, and seamless export of CAD assemblies. Users can programmatically edit variable studios, generate graph-based visualizations, and export URDF files tailored to their specific needs—all without being restricted by rigid workflows or naming conventions. By removing these constraints, the `onshape-robotics-toolkit` library empowers the robotics and CAD communities to create custom solutions for algorithmic design, optimization, and automation.
 
 &nbsp;
 
-# Key Features of `onshape-api`
+# Key Features of `onshape-robotics-toolkit`
 
-The `onshape-api` library is designed for users seeking a scalable, versatile API that empowers innovative robot design and control workflows. By integrating Onshape into algorithmic processes such as design optimization and automation, it unlocks the full potential of Onshape's cloud-based CAD system, fostering creativity and efficiency in robotics and beyond.
+The `onshape-robotics-toolkit` library is designed for users seeking a scalable, versatile API that empowers innovative robot design and control workflows. By integrating Onshape into algorithmic processes such as design optimization and automation, it unlocks the full potential of Onshape's cloud-based CAD system, fostering creativity and efficiency in robotics and beyond.
 
 &nbsp;
 
-| Feature                              | `onshape-api`                        | `onshape-to-robot`                      |
+| Feature                              | `onshape-robotics-toolkit`                        | `onshape-to-robot`                      |
 | ------------------------------------ | ------------------------------------ | --------------------------------------- |
 | **Workflow Flexibility**             | ✅ Open-ended and customizable       | ❌ Predefined and rigid                 |
 | **Design-Time Considerations**       | ✅ None                              | ❌ Requires specific naming conventions |
@@ -36,17 +36,17 @@ Before you begin, ensure you have the following:
 
 ## Installation
 
-You can install `onshape-api` using `pip`, which is the easiest way to install it and is the recommended method for most users.
+You can install `onshape-robotics-toolkit` using `pip`, which is the easiest way to install it and is the recommended method for most users.
 
 ```sh
-pip install onshape-api
+pip install onshape-robotics-toolkit
 ```
 
 If you want to install from source, you'll need to install [`poetry`](https://python-poetry.org/docs/) and [`git`](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) first. Then, you can clone the repository and install the package.
 
 ```sh
 git clone #
-cd onshape-api
+cd onshape-robotics-toolkit
 poetry install
 ```
 

docs/api/assembly.md

@@ -1 +1 @@
-::: onshape_api.models.assembly
+::: onshape_robotics_toolkit.models.assembly

docs/api/connect.md

@@ -1 +1 @@
-::: onshape_api.connect
+::: onshape_robotics_toolkit.connect

docs/api/document.md

@@ -1 +1 @@
-::: onshape_api.models.document
+::: onshape_robotics_toolkit.models.document

docs/api/element.md

@@ -1 +1 @@
-::: onshape_api.models.element
+::: onshape_robotics_toolkit.models.element

docs/api/geometry.md

@@ -1 +1 @@
-::: onshape_api.models.geometry
+::: onshape_robotics_toolkit.models.geometry

docs/api/graph.md

@@ -1 +1 @@
-::: onshape_api.graph
+::: onshape_robotics_toolkit.graph

docs/api/joint.md

@@ -1 +1 @@
-::: onshape_api.models.joint
+::: onshape_robotics_toolkit.models.joint

docs/api/link.md

@@ -1 +1 @@
-::: onshape_api.models.link
+::: onshape_robotics_toolkit.models.link

docs/api/log.md

@@ -1 +1 @@
-::: onshape_api.log
+::: onshape_robotics_toolkit.log

docs/api/mass.md

@@ -1 +1 @@
-::: onshape_api.models.mass
+::: onshape_robotics_toolkit.models.mass

docs/api/mesh.md

@@ -1 +1 @@
-::: onshape_api.mesh
+::: onshape_robotics_toolkit.mesh

docs/api/parse.md

@@ -1 +1 @@
-::: onshape_api.parse
+::: onshape_robotics_toolkit.parse

docs/api/robot.md

@@ -1,3 +1,3 @@
 # Robot
 
-::: onshape_api.robot
+::: onshape_robotics_toolkit.robot

docs/api/urdf.md

@@ -1 +1 @@
-::: onshape_api.urdf
+::: onshape_robotics_toolkit.urdf

docs/api/utilities.md

@@ -1 +1 @@
-::: onshape_api.utilities
+::: onshape_robotics_toolkit.utilities

docs/api/variable.md

@@ -1 +1 @@
-::: onshape_api.models.variable
+::: onshape_robotics_toolkit.models.variable

docs/contributing.md

@@ -1,4 +1,4 @@
-# Contributing to `onshape-api`
+# Contributing to `onshape-robotics-toolkit`
 
 Contributions are welcome, and they are greatly appreciated! Every little bit helps :)
 
@@ -8,7 +8,7 @@ Contributions are welcome, and they are greatly appreciated! Every little bit he
 
 ### Report Bugs
 
-Report bugs [here](https://github.com/senthurayyappan/onshape-api/issues)
+Report bugs [here](https://github.com/senthurayyappan/onshape-robotics-toolkit/issues)
 
 If you are reporting a bug, please include:
 
@@ -26,11 +26,11 @@ Look through the GitHub issues for features. Anything tagged with "enhancement"
 
 ### Write Documentation
 
-`onshape-api` could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.
+`onshape-robotics-toolkit` could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.
 
 ### Submit Feedback
 
-The best way to send feedback is to file an issue [here](https://github.com/senthurayyappan/onshape-api/issues).
+The best way to send feedback is to file an issue [here](https://github.com/senthurayyappan/onshape-robotics-toolkit/issues).
 
 If you are proposing a new feature:
 
@@ -42,21 +42,21 @@ If you are proposing a new feature:
 
 ## Get Started!
 
-Ready to contribute? Here's how to set up `onshape-api` for local development. Please note this documentation assumes you already have `poetry` and `Git` installed and ready to go.
+Ready to contribute? Here's how to set up `onshape-robotics-toolkit` for local development. Please note this documentation assumes you already have `poetry` and `Git` installed and ready to go.
 
-Fork the `onshape-api` repo on GitHub.
+Fork the `onshape-robotics-toolkit` repo on GitHub.
 
 Clone your fork locally:
 
 ```sh
 cd <directory_in_which_repo_should_be_created>
-git clone git@github.com:YOUR_NAME/onshape-api.git
+git clone git@github.com:YOUR_NAME/onshape-robotics-toolkit.git
 ```
 
 Now we need to install the environment. Navigate into the directory
 
 ```sh
-cd onshape-api
+cd onshape-robotics-toolkit
 ```
 
 Then, install and activate the environment with:

docs/developing.md

@@ -4,9 +4,9 @@
     <pre class="mermaid">
     sequenceDiagram
         participant User as User
-        participant Client as onshape-api.client
+        participant Client as onshape-robotics-toolkit.client
         participant Onshape as Onshape Server
-        participant Robot as onshape-api.robot
+        participant Robot as onshape-robotics-toolkit.robot
 
         User->>Client: Initialize Client with API Keys
         Client->>Onshape: Authenticate with Access Key & Secret Key

docs/getting-started.md

@@ -1,6 +1,6 @@
-# Getting Started with `onshape-api`
+# Getting Started with `onshape-robotics-toolkit`
 
-Welcome to the `onshape-api` library! This guide will help you set up and start using the library to interact with Onshape's powerful REST API.
+Welcome to the `onshape-robotics-toolkit` library! This guide will help you set up and start using the library to interact with Onshape's powerful REST API.
 
 The Onshape API allows developers to access, manipulate, and extend Onshape's CAD platform programmatically. The API communicates via HTTP requests, returning data in JSON format.
 
@@ -61,27 +61,27 @@ ACCESS_KEY = <your_access_key>
 SECRET_KEY = <your_secret_key>
 ```
 
-The `onshape-api` library will automatically read these keys to authenticate your requests.
+The `onshape-robotics-toolkit` library will automatically read these keys to authenticate your requests.
 
 ---
 
 ## Install the Library
 
-Install the `onshape-api` library via pip:
+Install the `onshape-robotics-toolkit` library via pip:
 
 ```sh
-pip install onshape-api
+pip install onshape-robotics-toolkit
 ```
 
 ---
 
 ## First API Call: Example Usage
 
-Here's an example of making a simple GET request to list documents using the `onshape-api` library:
+Here's an example of making a simple GET request to list documents using the `onshape-robotics-toolkit` library:
 
 ```python
-from onshape_api.connect import Client
-from onshape_api.models.document import Document
+from onshape_robotics_toolkit.connect import Client
+from onshape_robotics_toolkit.models.document import Document
 
 # Initialize the client
 client = osa.Client(
@@ -107,5 +107,5 @@ print(assembly)
 
 ## What's Next?
 
-- Check out more [examples and tutorials](tutorials/edit.md) in the `onshape-api` GitHub repository.
+- Check out more [examples and tutorials](tutorials/edit.md) in the `onshape-robotics-toolkit` GitHub repository.
 - Explore the [Onshape API Documentation](https://onshape-public.github.io/docs/) for detailed API reference.