pypi publish (#12)

* Create python-publish.yml

* (1) rename contents to onpy

* (2) rename src/ folder

.github/workflows/python-publish.yml

@@ -0,0 +1,41 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.12'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install -e '.[dev]'
+        python -m pip install build
+        
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

README.md

@@ -1,6 +1,6 @@
-# pyshape
+# onpy
 
 A comprehensive API for creating [OnShape](https://onshape.com) models entirely
 through Python.
 
-[![Integration Tests](https://github.com/kyle-tennison/pyshape/actions/workflows/validate.yml/badge.svg)](https://github.com/kyle-tennison/pyshape/actions/workflows/validate.yml)
+[![Integration Tests](https://github.com/kyle-tennison/onpy/actions/workflows/validate.yml/badge.svg)](https://github.com/kyle-tennison/onpy/actions/workflows/validate.yml)

examples/preliminary.py

@@ -1,10 +1,10 @@
 # A preliminary example of how this module should look
 
-from pyshape import Client
-from pyshape.features.sketch import Sketch
-from pyshape.features.extrude import Extrude
+from onpy import Client
+from onpy.features.sketch import Sketch
+from onpy.features.extrude import Extrude
 
-# from pyshape.features.extrude import Extrude
+# from onpy.features.extrude import Extrude
 
 client = Client()
 

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [project]
-name = "pyshape"
+name = "onpy"
 version = "0.0.1"
 requires-python = ">=3.12"
 authors = [

src/pyshape/__init__.py → src/onpy/__init__.py

@@ -9,4 +9,4 @@
 )
 
 
-from pyshape.client import Client
+from onpy.client import Client

src/pyshape/api/endpoints.py → src/onpy/api/endpoints.py

@@ -1,12 +1,12 @@
 """Contains different endpoints exposed to the RestApi object"""
 
-import pyshape.api.model as model
-from pyshape.api.versioning import VersionTarget
+import onpy.api.model as model
+from onpy.api.versioning import VersionTarget
 
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from pyshape.api.rest_api import RestApi
+    from onpy.api.rest_api import RestApi
 
 
 class EndpointContainer:
@@ -24,7 +24,7 @@ def document_create(self, name: str, description: str | None) -> model.Document:
         """Creates a new document"""
 
         if description is None:
-            description = "Created with pyshape"
+            description = "Created with onpy"
 
         return self.api.post(
             endpoint="/documents",

src/pyshape/api/rest_api.py → src/onpy/api/rest_api.py

@@ -2,10 +2,10 @@
 
 import json
 import sys
-from pyshape.api.endpoints import EndpointContainer
-from pyshape.api.model import ApiModel
-from pyshape.util.model import HttpMethod
-from pyshape.util.exceptions import PyshapeApiError, PyshapeInternalError
+from onpy.api.endpoints import EndpointContainer
+from onpy.api.model import ApiModel
+from onpy.util.model import HttpMethod
+from onpy.util.exceptions import PyshapeApiError, PyshapeInternalError
 
 import requests
 from requests.auth import HTTPBasicAuth
@@ -14,7 +14,7 @@
 from typing import TYPE_CHECKING, Callable
 
 if TYPE_CHECKING:
-    from pyshape.client import Client
+    from onpy.client import Client
 
 
 class RestApi:

src/pyshape/client.py → src/onpy/client.py

@@ -1,10 +1,10 @@
 """Entry point to this library"""
 
-from pyshape.util.credentials import CredentialManager
-from pyshape.api.rest_api import RestApi
-from pyshape.document import Document
-from pyshape.util.exceptions import PyshapeParameterError
-from pyshape.util.misc import find_by_name_or_id, UnitSystem
+from onpy.util.credentials import CredentialManager
+from onpy.api.rest_api import RestApi
+from onpy.document import Document
+from onpy.util.exceptions import PyshapeParameterError
+from onpy.util.misc import find_by_name_or_id, UnitSystem
 
 from loguru import logger
 

src/pyshape/document.py → src/onpy/document.py

@@ -1,17 +1,17 @@
 """Interface to managing OnShape documents"""
 
-import pyshape.api.model as model
-from pyshape.elements.partstudio import PartStudio
-from pyshape.elements.assembly import Assembly
-from pyshape.util.misc import find_by_name_or_id
-from pyshape.api.versioning import WorkspaceWVM
-from pyshape.util.exceptions import PyshapeParameterError
+import onpy.api.model as model
+from onpy.elements.partstudio import PartStudio
+from onpy.elements.assembly import Assembly
+from onpy.util.misc import find_by_name_or_id
+from onpy.api.versioning import WorkspaceWVM
+from onpy.util.exceptions import PyshapeParameterError
 
 from typing import TYPE_CHECKING, Any
 from functools import cache
 
 if TYPE_CHECKING:
-    from pyshape.client import Client
+    from onpy.client import Client
 
 
 class Document(model.NameIdFetchable):

src/pyshape/elements/assembly.py → src/onpy/elements/assembly.py

@@ -1,13 +1,13 @@
 """Assembly element interface"""
 
-from pyshape.elements.base import Element
-import pyshape.api.model as model
+from onpy.elements.base import Element
+import onpy.api.model as model
 
 from typing import TYPE_CHECKING, override
 
 if TYPE_CHECKING:
-    from pyshape.client import Client
-    from pyshape.document import Document
+    from onpy.client import Client
+    from onpy.document import Document
 
 
 class Assembly(Element):

src/pyshape/elements/base.py → src/onpy/elements/base.py

@@ -1,14 +1,14 @@
 """Abstract base class for OnShape elements (i.e., PartStudios, Assemblies, etc.)"""
 
-import pyshape.api.model as model
+import onpy.api.model as model
 
 from abc import abstractmethod, ABC
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from pyshape.client import Client
-    from pyshape.document import Document
-    from pyshape.api.rest_api import RestApi
+    from onpy.client import Client
+    from onpy.document import Document
+    from onpy.api.rest_api import RestApi
 
 
 class Element(ABC, model.NameIdFetchable):

src/pyshape/elements/partstudio.py → src/onpy/elements/partstudio.py

@@ -1,18 +1,18 @@
 """PartStudio element interface"""
 
 from loguru import logger
-from pyshape.elements.base import Element
-import pyshape.api.model as model
-from pyshape.features.base import Feature, FeatureList
-from pyshape.features.default_planes import DefaultPlane, DefaultPlaneOrientation
-from pyshape.api.versioning import WorkspaceWVM
-from pyshape.util.exceptions import PyshapeFeatureError
+from onpy.elements.base import Element
+import onpy.api.model as model
+from onpy.features.base import Feature, FeatureList
+from onpy.features.default_planes import DefaultPlane, DefaultPlaneOrientation
+from onpy.api.versioning import WorkspaceWVM
+from onpy.util.exceptions import PyshapeFeatureError
 
 from typing import TYPE_CHECKING, override
 
 if TYPE_CHECKING:
-    from pyshape.client import Client
-    from pyshape.document import Document
+    from onpy.client import Client
+    from onpy.document import Document
 
 
 class PartStudio(Element):

src/onpy/features/__init__.py

@@ -0,0 +1,2 @@
+from onpy.features.extrude import Extrude
+from onpy.features.sketch import Sketch

src/pyshape/features/base.py → src/onpy/features/base.py

@@ -1,16 +1,16 @@
 """Base class for sketches"""
 
-import pyshape.api.model as model
-from pyshape.util.exceptions import PyshapeParameterError
+import onpy.api.model as model
+from onpy.util.exceptions import PyshapeParameterError
 
 from abc import ABC, abstractmethod
 from typing import TYPE_CHECKING, Any, Iterator, Protocol
 
 if TYPE_CHECKING:
-    from pyshape.client import Client
-    from pyshape.document import Document
-    from pyshape.elements.partstudio import PartStudio
-    from pyshape.features.plane import Plane
+    from onpy.client import Client
+    from onpy.document import Document
+    from onpy.elements.partstudio import PartStudio
+    from onpy.features.plane import Plane
 
 
 class Feature(ABC):

src/pyshape/features/default_planes.py → src/onpy/features/default_planes.py

@@ -3,14 +3,14 @@
 from enum import Enum
 from textwrap import dedent
 from typing import TYPE_CHECKING, override
-from pyshape.features.base import Feature
-from pyshape.features.plane import Plane
-from pyshape.api.versioning import WorkspaceWVM
-import pyshape.api.model as model
+from onpy.features.base import Feature
+from onpy.features.plane import Plane
+from onpy.api.versioning import WorkspaceWVM
+import onpy.api.model as model
 
 if TYPE_CHECKING:
-    from pyshape.document import Document
-    from pyshape.elements.partstudio import PartStudio
+    from onpy.document import Document
+    from onpy.elements.partstudio import PartStudio
 
 
 class DefaultPlaneOrientation(Enum):

src/pyshape/features/entities/base.py → src/onpy/features/entities/base.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, abstractmethod
 import uuid
-import pyshape.api.model as model
+import onpy.api.model as model
 
 
 class Entity(ABC):

src/pyshape/features/entities/sketch_entities.py → src/onpy/features/entities/sketch_entities.py

@@ -3,9 +3,9 @@
 from enum import Enum
 import math
 from typing import override
-from pyshape.features.entities.base import Entity
-import pyshape.api.model as model
-from pyshape.util.misc import UnitSystem, Point2D
+from onpy.features.entities.base import Entity
+import onpy.api.model as model
+from onpy.util.misc import UnitSystem, Point2D
 
 
 class SketchCircle(Entity):

src/pyshape/features/extrude.py → src/onpy/features/extrude.py

@@ -1,12 +1,12 @@
 """OnShape extrusion feature"""
 
 from typing import TYPE_CHECKING, override
-from pyshape.api.model import Feature, FeatureAddResponse
-from pyshape.features.base import Feature, Extrudable
-import pyshape.api.model as model
+from onpy.api.model import Feature, FeatureAddResponse
+from onpy.features.base import Feature, Extrudable
+import onpy.api.model as model
 
 if TYPE_CHECKING:
-    from pyshape.elements.partstudio import PartStudio
+    from onpy.elements.partstudio import PartStudio
 
 
 class Extrude(Feature):

src/pyshape/features/plane.py → src/onpy/features/plane.py

@@ -1,6 +1,6 @@
 """Abstract Class for Planes"""
 
-from pyshape.features.base import Feature
+from onpy.features.base import Feature
 
 
 class Plane(Feature): ...

src/pyshape/features/sketch.py → src/onpy/features/sketch.py

@@ -3,15 +3,15 @@
 from typing import TYPE_CHECKING, override
 
 from loguru import logger
-from pyshape.features.base import Feature, Extrudable
-from pyshape.features.entities.base import Entity
-from pyshape.features.entities.sketch_entities import SketchCircle, SketchLine
-import pyshape.api.model as model
-from pyshape.util.misc import unwrap_type, unwrap, Point2D, UnitSystem
+from onpy.features.base import Feature, Extrudable
+from onpy.features.entities.base import Entity
+from onpy.features.entities.sketch_entities import SketchCircle, SketchLine
+import onpy.api.model as model
+from onpy.util.misc import unwrap_type, unwrap, Point2D, UnitSystem
 
 if TYPE_CHECKING:
-    from pyshape.elements.partstudio import PartStudio
-    from pyshape.features.plane import Plane
+    from onpy.elements.partstudio import PartStudio
+    from onpy.features.plane import Plane
 
 
 class Sketch(Feature, Extrudable):

src/pyshape/util/credentials.py → src/onpy/util/credentials.py

@@ -1,6 +1,6 @@
 """Manages OnShape credentials"""
 
-from pyshape.util.exceptions import PyshapeAuthError
+from onpy.util.exceptions import PyshapeAuthError
 
 import re
 import os
@@ -11,7 +11,7 @@
 class CredentialManager:
     """Manages token retrieval and credential storing"""
 
-    credential_path = os.path.expanduser(f"~/.pyshape/config.json")
+    credential_path = os.path.expanduser(f"~/.onpy/config.json")
 
     @staticmethod
     def is_secret_key(token: str | None) -> bool:
@@ -76,7 +76,7 @@ def fetch_dev_tokens() -> tuple[str, str] | None:
 
     @staticmethod
     def configure_file(access_token: str, secret_token: str) -> None:
-        """Creates a configuration file at ~/.pyshape/config.json
+        """Creates a configuration file at ~/.onpy/config.json
 
         Args:
             access_token: The access token/key from OnShape dev portal
@@ -115,7 +115,7 @@ def fetch_or_prompt() -> tuple[str, str]:
             return tokens
 
         logger.error(
-            "pyshape needs your OnShape credentials. \n"
+            "onpy needs your OnShape credentials. \n"
             "navagate to https://dev-portal.onshape.com/keys and generate a pair of "
             "access & secret keys. Paste them here when prompted:"
         )

src/pyshape/util/misc.py → src/onpy/util/misc.py

@@ -3,8 +3,8 @@
 from dataclasses import dataclass
 from enum import Enum
 from typing import Self
-from pyshape.api.model import NameIdFetchable
-from pyshape.util.exceptions import PyshapeParameterError
+from onpy.api.model import NameIdFetchable
+from onpy.util.exceptions import PyshapeParameterError
 
 
 def find_by_name_or_id[