Merge branch 'staging' into dev-heartbeat

Author: mstep44

.github/workflows/pypublish.yml

@@ -0,0 +1,71 @@
+# This workflow will upload a Python Package to PyPI 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: thermoflex
+
+on: 
+  push:
+    branches:
+    - main
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          cd python-serial/
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+          
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      url: https://pypi.org/p/thermoflex/
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: python-serial/dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: python-serial/dist/

.github/workflows/testpypublish.yml

@@ -0,0 +1,72 @@
+# This workflow will upload a Python Package to PyPI 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: thermo
+
+on: 
+  push:
+    branches:
+    - staging
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          cd python-serial/
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: python-serial/dist/
+          
+  testpypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      url: https://test.pypi.org/p/thermo/
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: python-serial/dist/
+          
+      - name: Publish distribution 📦 to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          packages-dir: python-serial/dist/

README.md

@@ -148,4 +148,4 @@ with $SRC being the path to the [python-serial](python-serial/) folder. This wil
 | setSetpoint(setpoint:float)      | Sets the setpoint of the muscle at the node.                                                                                              |
 | setEnable(bool)                  | Sets the enable status of the muscle in the node.                                                                                         |
 
-[Muscle](/docs/Thermoflex%20Glossary.md#muscle)
+[Muscle](/docs/Thermoflex%20Glossary.md#muscle)

python-serial/INSTALL INSTRUCTIONS

@@ -0,0 +1,2 @@
+copy the path to the .tar file from the staging/build/dist directory. This is the $SRC
+From powershell, Type 'pip install $SRC/thermoflex-0.0.3.tar'

python-serial/build/dist/thermoflex-0.0.1-py3-none-any.whl renamed to python-serial/dist/thermoflex-0.0.1-py3-none-any.whl

@@ -7,6 +7,7 @@ name = "thermoflex"
 version = "1.0.1"
 authors = [{name = "Marvin S", email = "[email protected]"}, {name = "Mark D", email = "[email protected]"} ]
 readme = "Getting Started.md"
+
 dependencies = ['pyserial == 3.5','protobuf == 5.28.3', 'pandas == 2.2.3']
 description = "This is the library for controlling the ThermoFlex muscle system by Delta Robotics"
 keywords = ["thermoflex" , "Delta", "Delta Robotics"]

python-serial/build/dist/thermoflex-0.0.1.tar.gz renamed to python-serial/dist/thermoflex-0.0.1.tar.gz

@@ -0,0 +1,6 @@
+```
+pip install $filepath\dist\thermoflex-0.0.1.tar.gz
+```
+
+use this command in powershell or python terminal.
+$filepath is the path to the dist\ folder in python-serial

python-serial/pyproject.toml

@@ -0,0 +1,6 @@
+
+from .sessions import *
+
+#my library is the brains of the operation. Everything happens here. 
+#make Markdown file
+#Getting Started, Markdown with commands, Basic tutorial