to staging

.github/workflows/testpypublish.yml

@@ -37,7 +37,7 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: release-dists
-          path: dist/
+          path: python-serial/dist/
 
   testpypi-publish:
     runs-on: ubuntu-latest
@@ -52,7 +52,7 @@ jobs:
     environment:
       name: pypi
       # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
-      url: https://pypi.org/p/thermo/
+      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:
@@ -64,8 +64,9 @@ jobs:
         with:
           name: release-dists
           path: python-serial/dist/
-
-      - name: Publish release distributions to PyPI
+          
+      - 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/

python-serial/Getting Started.md

@@ -1,41 +1,41 @@
-# Getting Started
-
-#### System Requirements
-
-- Python 3.12 or greater
-- Pyserial 3.5 or greater
-
-## Introduction
-
-###### The Thermoflex muscle is a current activated artificial muscle that is designed to have a low profile usage and simple activation and deactivation sequence. The purpose of this library is 2-fold; to become the working backend of the Delta hardware application and to allow for open-source development of the Nitinol muscle.
-
-## First steps
-
-Ensure that you have a Node and Muscle device. 
-
-Install the thermoflex library. You can do this 3 different ways.
-    
-1. Type this command into Powershell
-
-    ```
-    pip install thermoflex
-    ```
-    
-2. From the thermoflex repository, download the python-serial folder,cd to the build folder, and type this command.
-
-    ```bash
-    pip install thermoflex-0.0.3.tar.gz 
-    ```
-    
-3. After downloading the thermoflex repository, cd into the folder and type this command
-
-    ```bash
-    pip install python-serial/
-    ```
-
-After installing the library, connect the Muscle to the Node and the Node to the computer. 
-
-There is an example python script muscle-simple.py in the getting started folder to help you understand the flow of the system.
-Simply run the file and the muscle should contract, update for 5 seconds, and then release. Then the program will end.
-
-The README in the thermoflex repository has a glossary containing all of the working commands.
+
+### System Requirements
+
+- Python 3.12 or greater
+- Pyserial 3.5 or greater
+
+## Introduction
+
+ The Thermoflex muscle is a current activated artificial muscle that is designed to have a low profile usage and simple activation and deactivation sequence. The purpose of this library is 2-fold; to become the working backend of the Delta hardware application and to allow for open-source development of the Nitinol muscle.
+
+## First steps
+
+Ensure that you have a Node and Muscle device. 
+
+Install the thermoflex library. You can do this 3 different ways.
+    
+1. Type this command into Powershell
+    
+    ```
+    pip install thermoflex
+    ```
+    
+2. From the thermoflex repository, download the [python-serial](https://github.com/Delta-Robotics-Inc/ThermoFlex-Python-API/tree/main/python-serial) folder,cd to the build folder, and type this command.
+    
+    ```bash
+    pip install python-serial/
+    ``` 
+    
+3. Download the latest release from [Github Releases](https://github.com/Delta-Robotics-Inc/ThermoFlex-Python-API/releases), cd into the folder and type this command
+    
+     ```bash
+    pip install thermoflex-1.0.1.tar.gz 
+    ```
+    *The version number is subject to change*
+
+After installing the library, connect the Muscle to the Node and the Node to the computer. 
+
+There is an example python script [muscle-simple.py](https://github.com/Delta-Robotics-Inc/ThermoFlex-Python-API/blob/main/getting-started/muscle-simple.py) in the getting started folder to help you understand the flow of the system.
+Simply run the file and the muscle should contract, update for 5 seconds, and then release. Then the program will end.
+
+There is a [Glossary](https://github.com/Delta-Robotics-Inc/ThermoFlex-Python-API/blob/main/docs/Thermoflex%20Glossary.md) of the working commands and features in the library.

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/pyproject.toml

@@ -3,9 +3,10 @@ requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "thermoflex"
+name = "thermo"
 version = "1.0.0"
-authors = [{name = "Marvin S", email = "[email protected]"}, {name = "Mark D", email = "[email protected]"} ]
+authors = [{name = "Marvin Stephens", email = "[email protected]"}, {name = "Mark D", email = "[email protected]"}]
+
 readme = "README.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"

python-serial/staging/Installation instructions for the thermoflex API.md

@@ -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/staging/src/__init__.py

@@ -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