fixing tests

renaming package ispprogrammer to match pypi

Author: snhobbs

.github/workflows/cd.yml

@@ -0,0 +1,76 @@
+name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+
+on: push
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/ISPProgrammer  # Replace <package-name> with your PyPI project name
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  publish-to-testpypi:
+    name: Publish Python 🐍 distribution 📦 to TestPyPI
+    needs:
+    - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/ISPProgrammer
+
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/

.github/workflows/pyinstaller-package.yml

@@ -31,7 +31,7 @@ jobs:
 
     - name: Verify Installations
       run: |
-        python3 -m pip show isp_programmer
+        python3 -m pip show ispprogrammer
         python3 -m pip show pyserial
 
     - name: Make executable

.github/workflows/python-app.yml

@@ -0,0 +1,38 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python application
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.9"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install .
+        pip install ruff pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with ruff
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        ruff check --exit-non-zero-on-fix
+    - name: Test with pytest
+      run: |
+        pytest

.github/workflows/python-package.yml

@@ -46,7 +46,7 @@ The configuration file is identical to that used by the [lpctools project](http:
 ### From PyPI
 
 ```bash
-pip install isp_programmer
+pip install ispprogrammer
 ```
 
 ### From Source
@@ -62,17 +62,17 @@ pip install .
 ## Usage
 ### Erase Entire Flash
 ```bash
-isp_programmer --device /dev/ttyUSB0 -b 9600 -crystal_frequency 12000 masserase
+ispprogrammer --device /dev/ttyUSB0 -b 9600 -crystal_frequency 12000 masserase
 ```
 
 ### Program Flash Image
 ```bash
-isp_programmer --device /dev/ttyUSB0 -b 9600 -crystal_frequency 12000 writeimage --imagein blinky804.hex
+ispprogrammer --device /dev/ttyUSB0 -b 9600 -crystal_frequency 12000 writeimage --imagein blinky804.hex
 ```
 
 ### Read Chip Info
 ```bash
-isp_programmer --device /dev/ttyUSB0 -b 9600 -crystal_frequency 12000 querychip
+ispprogrammer --device /dev/ttyUSB0 -b 9600 -crystal_frequency 12000 querychip
 ```
 
 ## Similar Projects

.github/workflows/pythonpublish.yml

@@ -4,7 +4,7 @@ from PyInstaller.utils.hooks import collect_all
 datas = []
 binaries = []
 hiddenimports = []
-tmp_ret = collect_all('isp_programmer')
+tmp_ret = collect_all('ispprogrammer')
 datas += tmp_ret[0]; binaries += tmp_ret[1]; hiddenimports += tmp_ret[2]
 tmp_ret = collect_all('serial')
 datas += tmp_ret[0]; binaries += tmp_ret[1]; hiddenimports += tmp_ret[2]

README.md

@@ -11,11 +11,11 @@
 import queue
 import serial
 import serial.tools.list_ports
-import isp_programmer.cli
+import ispprogrammer.cli
 
 __version__ = "v1.2.1"
 
-_log = logging.getLogger("isp_programmer_gui")
+_log = logging.getLogger("ispprogrammer_gui")
 _min_frame_size = (200, 300)
 _frame_size = (600, 800)
 
@@ -54,8 +54,8 @@ def setup_log_handler(log, output_queue, level=logging.INFO):
     log.setLevel(level)
     log.addHandler(handler)
 
-    logging.getLogger("isp_programmer").addHandler(handler)
-    logging.getLogger("isp_programmer").setLevel(logging.INFO)
+    logging.getLogger("ispprogrammer").addHandler(handler)
+    logging.getLogger("ispprogrammer").setLevel(logging.INFO)
 
 
 class WorkerThread(threading.Thread):
@@ -126,34 +126,34 @@ def get(self):
         return self.file_path.get()
 
 
-def program_isp_task(
+def program_isptask(
     image, device, output_queue, baud=115200, crystal_frequency=12000, no_sync=False
 ):
     setup_log_handler(_log, output_queue)
-    isp, chip = isp_programmer.cli.SetupChip(
+    isp, chip = ispprogrammer.cli.SetupChip(
         baud,
         device,
         crystal_frequency,
-        isp_programmer.cli._chip_defs,
+        ispprogrammer.cli._chip_defs,
         no_sync,
     )
-    bin_ = isp_programmer.cli.read_image_file_to_bin(image)
-    isp_programmer.cli.WriteImage(isp, chip, bin_)
+    bin_ = ispprogrammer.cli.read_image_file_to_bin(image)
+    ispprogrammer.cli.WriteImage(isp, chip, bin_)
     isp.Go(0)
 
 
 def erase_task(
     device, output_queue, baud=115200, crystal_frequency=12000, no_sync=False
 ):
     setup_log_handler(_log, output_queue)
-    isp, chip = isp_programmer.cli.SetupChip(
+    isp, chip = ispprogrammer.cli.SetupChip(
         baud,
         device,
         crystal_frequency,
-        isp_programmer.cli._chip_defs,
+        ispprogrammer.cli._chip_defs,
         no_sync,
     )
-    isp_programmer.cli.MassErase(isp, chip)
+    ispprogrammer.cli.MassErase(isp, chip)
 
 
 class MyFrame(tk.Tk):
@@ -206,10 +206,10 @@ def __init__(self, parent, title):
         self.sync_checkbutton.pack(anchor=tk.W, padx=5, pady=5)
 
         # program isp button
-        self.run_isp_button = tk.Button(
+        self.run_ispbutton = tk.Button(
             self, text="Program", command=self.on_run_program_isp
         )
-        self.run_isp_button.pack(pady=10)
+        self.run_ispbutton.pack(pady=10)
 
         # erase isp button
         self.run_erase_button = tk.Button(self, text="Erase", command=self.on_run_erase)
@@ -298,7 +298,7 @@ def on_run_program_isp(self):
         bin_file = self.file_picker.get()
         self.update_text(f"Starting task. Device {com_choice}, Bin {bin_file}\n")
         command = functools.partial(
-            program_isp_task,
+            program_isptask,
             image=bin_file,
             device=com_choice,
             no_sync=(not self.sync_mode.get()),
@@ -339,7 +339,7 @@ def main():
 
     log_format = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
     logging.basicConfig(format=log_format)
-    logging.getLogger("isp_programmer").setLevel(logging.DEBUG)
+    logging.getLogger("ispprogrammer").setLevel(logging.DEBUG)
     _log.setLevel(logging.INFO)
     app.mainloop()
 

packaging/gui-tk.spec

@@ -1,5 +1,5 @@
 [project]
-name = "isp_programmer"
+name = "ispprogrammer"
 version = "1.2.1"
 description='NXP ISP Cortex-M programming tool'
 authors = [
@@ -22,19 +22,20 @@ dependencies = [
 ]
 
 [project.urls]
-repository='https://github.com/snhobbs/NXPISP'
-url='https://github.com/snhobbs/NXPISP'
+repository='https://github.com/snhobbs/isp-programmer'
+url='https://github.com/snhobbs/isp-programmer'
 
 [project.scripts]
-isp_programmer = "isp_programmer.cli:main"
-ISPProgrammer = "isp_programmer.cli:main"
-isp-programmer-gui = "isp_programmer.gui:main"
+ispprogrammer = "ispprogrammer.cli:main"
+ISPProgrammer = "ispprogrammer.cli:main"
+isp-programmer-gui = "ispprogrammer.gui:main"
+ispprogrammer-gui = "ispprogrammer.gui:main"
 
 [tool.setuptools]
 include-package-data = true
 
 [tool.setuptools.packages.find]
-where = ["src", "src/isp_programmer"]
+where = ["src", "src/ispprogrammer"]
 
 [build-system]
 requires = [
@@ -43,7 +44,7 @@ requires = [
 ]
 
 [tool.setuptools.package-data]
-isp_programmer= ["*.def", "*.ini", "src/isp_programmer/lpctools_parts.def"]
+ispprogrammer= ["*.def", "*.ini", "src/ispprogrammer/lpctools_parts.def"]
 
 [tool.pylint]
 max-line-length = 200