onshape-sdk-pr 0.1.2__tar.gz

onshape_sdk_pr-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Zach Sharma
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

onshape_sdk_pr-0.1.2/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: onshape-sdk-pr
+Version: 0.1.2
+Summary: A lightweight, typed Python SDK for the Onshape REST API
+Author-email: Zach Sharma <zachariah.sharma@gmail.com>, PawRequest <nomail@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/pawrequest/onshape-sdk
+Keywords: onshape,cad,api,sdk,rest
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pydantic>=2.14.2
+Requires-Dist: pydantic-settings>=2.16.2
+Requires-Dist: python-dotenv>=1.0
+Requires-Dist: requests>=2.28
+Dynamic: license-file
+
+# onshape-sdk-pawrequest
+
+A lightweight, typed Python SDK for the [Onshape REST API](https://onshape-public.github.io/docs/).
+
+Upstream Documentation: [https://zachariahsharma.github.io/onshape-sdk/](https://zachariahsharma.github.io/onshape-sdk/)
+
+Upstream didn't work for some routes and it's api_version is old, so i forked.
+
+I have not tested all routes, ymmv.  
+
+Major Fork changes:
+
+- Updated API version from 6 to 10
+- Fixed some broken routes
+- Added pydantic-settings
+- Changed the auth setup. (`onshape_sdk.auth.OnshapeHmacAuth`)
+
+## Install
+
+```
+git clone <rep-url>
+```
+
+or don't and use uv:
+
+```shell
+uv tool run --from git+https://github.com/pawrequest/onshape-sdk onshape-sdk export
+```
+
+### Configuration
+
+Create Onshape API access and secret keys via the developer portal on OnShape's website.
+
+PydanticSettings are built from .env file or environment variables.  
+Place a .env with required inputs in default location "<project_root>/.env"  (sibling of this readme)  
+Or do one of:
+
+- Pass custom .env locations to `OnshapeSettings(_env_file=<path_to_env_file>)`,
+- Set the required inputs in your environment,
+- Instantiate `OnshapeSettings` with the required inputs.
+
+#### required inputs
+
+ONSHAPE_ACCESS_KEY=your_access_key  
+ONSHAPE_SECRET_KEY=your_secret_key
+
+## Usage
+
+### cli
+
+cli entry is via uv from `src/main.py` - see there fore details.  
+uv sets `onshape-sdk` as the program name
+`onshape-sdk <command> <command options>`  
+atm i mostly use this project as an exporter to speed up iterating from onshape to slicer.
+
+Commands:
+
+- Export
+
+```
+onshape-sdk export /
+    -u <url-to-partstudio> /
+    -o <optional output file or dir> /  # save exported stl bytes
+    -pf <optional part-name filter>
+
+```
+
+### python
+
+```python
+from onshape_sdk import OnshapeClient, OnshapeIdsTup, OnshapeSettings
+
+settings = OnshapeSettings()  # optional - otherwise read default .env location or env_vars 
+client = OnshapeClient(settings)  # or just `OnshapeClient() for defaults`
+url = '<ONSHAPE_URL>'
+ids = OnshapeIdsTup.from_url(url)
+bom = client.assemblies.get_bom(*ids)
+for row in bom.rows:
+    print(row.part_number, row.name, row.quantity, row.material_name)
+```
+
+## License
+
+MIT

onshape_sdk_pr-0.1.2/README.md

@@ -0,0 +1,84 @@
+# onshape-sdk-pawrequest
+
+A lightweight, typed Python SDK for the [Onshape REST API](https://onshape-public.github.io/docs/).
+
+Upstream Documentation: [https://zachariahsharma.github.io/onshape-sdk/](https://zachariahsharma.github.io/onshape-sdk/)
+
+Upstream didn't work for some routes and it's api_version is old, so i forked.
+
+I have not tested all routes, ymmv.  
+
+Major Fork changes:
+
+- Updated API version from 6 to 10
+- Fixed some broken routes
+- Added pydantic-settings
+- Changed the auth setup. (`onshape_sdk.auth.OnshapeHmacAuth`)
+
+## Install
+
+```
+git clone <rep-url>
+```
+
+or don't and use uv:
+
+```shell
+uv tool run --from git+https://github.com/pawrequest/onshape-sdk onshape-sdk export
+```
+
+### Configuration
+
+Create Onshape API access and secret keys via the developer portal on OnShape's website.
+
+PydanticSettings are built from .env file or environment variables.  
+Place a .env with required inputs in default location "<project_root>/.env"  (sibling of this readme)  
+Or do one of:
+
+- Pass custom .env locations to `OnshapeSettings(_env_file=<path_to_env_file>)`,
+- Set the required inputs in your environment,
+- Instantiate `OnshapeSettings` with the required inputs.
+
+#### required inputs
+
+ONSHAPE_ACCESS_KEY=your_access_key  
+ONSHAPE_SECRET_KEY=your_secret_key
+
+## Usage
+
+### cli
+
+cli entry is via uv from `src/main.py` - see there fore details.  
+uv sets `onshape-sdk` as the program name
+`onshape-sdk <command> <command options>`  
+atm i mostly use this project as an exporter to speed up iterating from onshape to slicer.
+
+Commands:
+
+- Export
+
+```
+onshape-sdk export /
+    -u <url-to-partstudio> /
+    -o <optional output file or dir> /  # save exported stl bytes
+    -pf <optional part-name filter>
+
+```
+
+### python
+
+```python
+from onshape_sdk import OnshapeClient, OnshapeIdsTup, OnshapeSettings
+
+settings = OnshapeSettings()  # optional - otherwise read default .env location or env_vars 
+client = OnshapeClient(settings)  # or just `OnshapeClient() for defaults`
+url = '<ONSHAPE_URL>'
+ids = OnshapeIdsTup.from_url(url)
+bom = client.assemblies.get_bom(*ids)
+for row in bom.rows:
+    print(row.part_number, row.name, row.quantity, row.material_name)
+```
+
+## License
+
+MIT

onshape_sdk_pr-0.1.2/onshape_sdk/__init__.py

@@ -0,0 +1,101 @@
+"""Onshape Python SDK — typed client for the Onshape REST API.
+
+Quick start
+-----------
+>>> from onshape_sdk import OnshapeClient, parse_onshape_url
+>>> client = OnshapeClient()  # reads .env
+>>> client.test_auth()
+>>> ids = parse_onshape_url("https://cad.onshape.com/documents/…/w/…/e/…")
+>>> parts = client.parts.list(ids["did"], ids["wvm_type"], ids["wvm_id"], ids["eid"])
+"""
+
+from .client import OnshapeClient
+from .ids import OnshapeIdsTup
+from .settings import OnshapeSettings
+from .utils import OnshapeIds, build_wvm_path, parse_onshape_url
+
+# Types — re-exported so users can do ``from onshape_sdk import Document, Part, …``
+from .types import (
+    AssemblyDefinition,
+    BomHeader,
+    BomRow,
+    BomTable,
+    Document,
+    DocumentVersion,
+    DrawingView,
+    Element,
+    Feature,
+    FeatureParameter,
+    MateFeature,
+    MetadataProperty,
+    Occurrence,
+    Owner,
+    PaginatedList,
+    Part,
+    ThumbnailInfo,
+    ThumbnailSize,
+    TranslationStatus,
+    UserInfo,
+    Variable,
+    Webhook,
+    Workspace,
+)
+
+# Resource APIs — importable for type annotations
+from .assemblies import AssembliesApi
+from .blob_elements import BlobElementsApi
+from .documents import DocumentsApi
+from .drawings import DrawingsApi
+from .metadata import MetadataApi
+from .parts import PartsApi
+from .part_studios import PartStudiosApi
+from .thumbnails import ThumbnailsApi
+from .translations import TranslationError, TranslationsApi
+from .webhooks import WebhooksApi
+
+__all__ = [
+    # Client
+    'OnshapeClient',
+    'OnshapeSettings',
+    'OnshapeIdsTup',
+    # Utils
+    'parse_onshape_url',
+    'build_wvm_path',
+    'OnshapeIds',
+    # Types
+    'AssemblyDefinition',
+    'BomHeader',
+    'BomRow',
+    'BomTable',
+    'Document',
+    'DocumentVersion',
+    'DrawingView',
+    'Element',
+    'Feature',
+    'FeatureParameter',
+    'MateFeature',
+    'MetadataProperty',
+    'Occurrence',
+    'Owner',
+    'PaginatedList',
+    'Part',
+    'ThumbnailInfo',
+    'ThumbnailSize',
+    'TranslationError',
+    'TranslationStatus',
+    'UserInfo',
+    'Variable',
+    'Webhook',
+    'Workspace',
+    # Resource APIs
+    'AssembliesApi',
+    'BlobElementsApi',
+    'DocumentsApi',
+    'DrawingsApi',
+    'MetadataApi',
+    'PartsApi',
+    'PartStudiosApi',
+    'ThumbnailsApi',
+    'TranslationsApi',
+    'WebhooksApi',
+]

onshape_sdk_pr-0.1.2/onshape_sdk/api_version.py

@@ -0,0 +1,3 @@
+API_VERSION = 'v10'
+API_VERSION_PATH = f'/api/{API_VERSION}'
+BASE_API_PATH = f'https://cad.onshape.com{API_VERSION_PATH}'

onshape_sdk_pr-0.1.2/onshape_sdk/assemblies.py

@@ -0,0 +1,156 @@
+"""Assemblies API — definitions, BOM, occurrences, mates."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any, Optional
+
+from .api_version import API_VERSION_PATH
+from .types import AssemblyDefinition, BomTable, MateFeature, Occurrence
+from .utils import build_wvm_path
+
+if TYPE_CHECKING:
+    from .client import OnshapeClient
+
+
+class AssembliesApi:
+    """Endpoints under ``/{API_VERSION_PATH}/assemblies``."""
+
+    _BASE = f'/assemblies'
+
+    def __init__(self, client: 'OnshapeClient') -> None:
+        self._c = client
+
+    def _path(self, did: str, wvm: str, wvm_id: str, eid: str) -> str:
+        return f'{self._BASE}{build_wvm_path(did, wvm, wvm_id, eid)}'
+
+    # ── Definition ────────────────────────────────────────────────────────────
+
+    def get_definition(
+        self,
+        did: str,
+        wvm: str,
+        wvm_id: str,
+        eid: str,
+        *,
+        include_mate_features: bool = False,
+        include_non_solids: bool = False,
+    ) -> AssemblyDefinition:
+        """Get the full assembly definition (parts, sub-assemblies, instances)."""
+        params: dict = {}
+        if include_mate_features:
+            params['includeMateFeatures'] = 'true'
+        if include_non_solids:
+            params['includeNonSolids'] = 'true'
+        r = self._c.get(
+            f'{self._path(did, wvm, wvm_id, eid)}',
+            query_params=params or None,
+        )
+        r.raise_for_status()
+        return AssemblyDefinition.from_dict(r.json())
+
+    # ── BOM ───────────────────────────────────────────────────────────────────
+
+    def get_bom(
+        self,
+        did: str,
+        wvm: str,
+        wvm_id: str,
+        eid: str,
+        *,
+        indented: bool = True,
+        multi_level: bool = True,
+    ) -> BomTable:
+        """Get the Bill of Materials for the assembly."""
+        params: dict = {
+            'indented': str(indented).lower(),
+            'multiLevel': str(multi_level).lower(),
+        }
+        r = self._c.get(
+            f'{self._path(did, wvm, wvm_id, eid)}/bom',
+            query_params=params,
+        )
+        r.raise_for_status()
+        return BomTable.from_dict(r.json())
+
+    # ── Features (mates) ─────────────────────────────────────────────────────
+
+    def get_features(
+        self,
+        did: str,
+        wvm: str,
+        wvm_id: str,
+        eid: str,
+    ) -> list[MateFeature]:
+        """Get mate features in the assembly."""
+        r = self._c.get(f'{self._path(did, wvm, wvm_id, eid)}/features')
+        r.raise_for_status()
+        data = r.json()
+        raw = data.get('features', data if isinstance(data, list) else [])
+        return [MateFeature.from_dict(f) for f in raw if isinstance(f, dict)]
+
+    # ── Occurrences ──────────────────────────────────────────────────────────
+
+    def get_occurrences(
+        self,
+        did: str,
+        wvm: str,
+        wvm_id: str,
+        eid: str,
+    ) -> list[Occurrence]:
+        """List all part occurrences with their transforms."""
+        r = self._c.get(f'{self._path(did, wvm, wvm_id, eid)}/occurrences')
+        r.raise_for_status()
+        return [Occurrence.from_dict(o) for o in r.json()]
+
+    # ── Write operations ─────────────────────────────────────────────────────
+
+    def insert_instance(
+        self,
+        did: str,
+        wid: str,
+        eid: str,
+        *,
+        document_id: str,
+        element_id: str,
+        part_id: Optional[str] = None,
+        version_id: Optional[str] = None,
+        is_assembly: bool = False,
+    ) -> dict[str, Any]:
+        """Insert a part or sub-assembly instance into the assembly."""
+        body: dict = {
+            'documentId': document_id,
+            'elementId': element_id,
+            'isAssembly': is_assembly,
+        }
+        if part_id:
+            body['partId'] = part_id
+        if version_id:
+            body['versionId'] = version_id
+        r = self._c.post(
+            f'{self._path(did, "w", wid, eid)}/instances',
+            body=body,
+        )
+        r.raise_for_status()
+        return r.json()
+
+    def transform_occurrences(
+        self,
+        did: str,
+        wid: str,
+        eid: str,
+        transforms: list[dict],
+    ) -> dict[str, Any]:
+        """Apply transforms to occurrences.
+
+        Parameters
+        ----------
+        transforms : list[dict]
+            Each dict should contain ``path`` (list[str]) and ``transform``
+            (list[float] — 16-element row-major 4×4 matrix).
+        """
+        r = self._c.post(
+            f'{self._path(did, "w", wid, eid)}/occurrencetransforms',
+            body={'occurrences': transforms, 'isRelative': True},
+        )
+        r.raise_for_status()
+        return r.json()

onshape_sdk_pr-0.1.2/onshape_sdk/auth.py

@@ -0,0 +1,59 @@
+import base64
+import hmac
+import secrets
+import string
+from collections.abc import Generator
+from email.utils import formatdate
+
+import httpx
+from pydantic import SecretStr
+
+_NONCE_CHARS = string.ascii_letters + string.digits
+
+
+class SecretBasicAuth(httpx.Auth):
+    def __init__(self, username: SecretStr, password: SecretStr) -> None:
+        self._username = username
+        self._password = password
+
+    def auth_flow(self, request: httpx.Request):
+        # unwrapped per request, never stored as plain str on self
+        basic = httpx.BasicAuth(
+            self._username.get_secret_value(),
+            self._password.get_secret_value(),
+        )
+        yield from basic.auth_flow(request)
+
+    def __repr__(self) -> str:
+        return f'{type(self).__name__}(<redacted>)'
+
+
+class OnshapeHmacAuth(httpx.Auth):
+    def __init__(self, access_key: SecretStr, secret_key: SecretStr) -> None:
+        self._access = access_key
+        self._secret = secret_key
+
+    def auth_flow(self, request: httpx.Request) -> Generator[httpx.Request, httpx.Response, None]:
+        nonce = ''.join(secrets.choice(_NONCE_CHARS) for _ in range(25))
+        date = formatdate(usegmt=True)
+        content_type = request.headers.get('content-type', 'application/json')
+        path = request.url.raw_path.split(b'?', 1)[0].decode()
+        query = request.url.query.decode()
+
+        signing_string = (
+            f'{request.method}\n{nonce}\n{date}\n{content_type}\n{path}\n{query}\n'
+        ).lower()
+
+        access = self._access.get_secret_value()
+        digest = hmac.digest(
+            self._secret.get_secret_value().encode(), signing_string.encode(), 'sha256'
+        )
+        sig = base64.b64encode(digest).decode()
+
+        request.headers['Date'] = date
+        request.headers['On-Nonce'] = nonce
+        request.headers['Authorization'] = f'On {access}:HmacSHA256:{sig}'
+        yield request
+
+    def __repr__(self) -> str:
+        return f'{type(self).__name__}(<redacted>)'

onshape_sdk_pr-0.1.2/onshape_sdk/blob_elements.py

@@ -0,0 +1,81 @@
+"""Blob Elements API — upload and download binary files."""
+
+from __future__ import annotations
+
+import os
+from typing import TYPE_CHECKING, Optional
+
+import requests as _requests
+
+from .api_version import API_VERSION_PATH
+from .types import Element
+from .utils import build_wvm_path
+
+if TYPE_CHECKING:
+    from .client import OnshapeClient
+
+
+class BlobElementsApi:
+    """Endpoints under ``/{API_VERSION_PATH}/blobelements``."""
+
+    _BASE = f'/blobelements'
+
+    def __init__(self, client: 'OnshapeClient') -> None:
+        self._c = client
+
+    def download(
+        self,
+        did: str,
+        wvm: str,
+        wvm_id: str,
+        eid: str,
+    ) -> bytes:
+        """Download the raw contents of a blob element.
+
+        Handles the S3 redirect that Onshape typically returns.
+        """
+        path = f'{self._BASE}{build_wvm_path(did, wvm, wvm_id, eid)}'
+        r = self._c.get(path, accept='application/octet-stream')
+        if r.status_code in (301, 302, 303, 307, 308):
+            r = _requests.get(r.headers['Location'])
+        r.raise_for_status()
+        return r.content
+
+    def upload(
+        self,
+        did: str,
+        wid: str,
+        file_path: str,
+        *,
+        content_type: Optional[str] = None,
+    ) -> Element:
+        """Upload a file as a new blob element in the document.
+
+        Parameters
+        ----------
+        file_path : str
+            Local file to upload.
+        content_type : str, optional
+            MIME type.  Auto-detected from extension if not given.
+        """
+        if not content_type:
+            import mimetypes
+
+            content_type = mimetypes.guess_type(file_path)[0] or 'application/octet-stream'
+
+        filename = os.path.basename(file_path)
+        path = f'{self._BASE}/d/{did}/w/{wid}'
+
+        # Build multipart headers manually since Onshape expects
+        # the HMAC to be signed with application/json content type
+        # but the actual upload is multipart
+        # headers = self._c._sign('POST', path, content_type='application/json')
+        # del headers['Content-Type']  # let requests set the multipart boundary
+
+        with open(file_path, 'rb') as f:
+            files = {'file': (filename, f, content_type)}
+            url = self._c.base_url + path
+            r = _requests.post(url, files=files)
+
+        r.raise_for_status()
+        return Element.from_dict(r.json())