Commit for automatic PyPi deployment on tag creation.

.github/workflows/python-publish.yml

@@ -0,0 +1,44 @@
+name: Build, Test, and Upload Python Package
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+      
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  # test:
+  #      uses: ./.github/workflows/ubuntu-python-package.yml  # use the callable tests job to run tests
+
+  deploy:
+
+    runs-on: ubuntu-latest
+
+  #  needs: [test]
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.11"
+
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        python -m pip install --upgrade pip
+
+    - name: Publish to PyPI
+      run: |
+        python -m venv venv
+        . ./venv/bin/activate
+        pip install -U twine build
+        python -m build .
+        python -m twine upload --repository pypi --username __token__ --password ${{ secrets.PYPI }} dist/* 
+      env:
+        PYPI: ${{ secrets.PYPI }}

CHANGELOG.md

@@ -1,4 +1,6 @@
 # Changelog
 
+### Version 0.0.2 (17-04-2024)
+- Automatic deployment to PyPi using GitHub Actions
 ### Version 0.0.1 (15-04-2024)
 - Initial release

README.md

@@ -32,7 +32,7 @@ pip install .
 ## Usage
 The module is used together with the ATM-system. Connect the ATM-system to the PC running the NQRduck program. You can connect to the ATM-system using the 'Tuning and Matching' tab in the NQRduck program.
 
-<img src="docs/img/autotm-labeled.png" alt="drawing" width="800">
+<img src="https://raw.githubusercontent.com/nqrduck/nqrduck-autotm/2860c826f056182e89e7cb2b9bac5c78420d9a29/docs/img/autotm-labeled.png" alt="drawing" width="800">
 
 - a.) The Connection settings for connecting to the ATM-system.
 - b.) The 'Tuning and Matching' tab. Here you can control the ATM-system and switch between electrically and mechanically tunable probe coils.

pyproject.toml

@@ -4,12 +4,12 @@ build-backend = "hatchling.build"
 
 [project]
 name = "nqrduck-autotm"
-version = "0.0.1"
+version = "0.0.2"
 authors = [
-  { name="Julia Pfitzer", email="git@jupfi.me" },
+  { name="jupfi", email="support@nqrduck.cool" },
 ]
 
-description = "A module for the NQRduck program (a simple python script™) for automatic Tuning and Matching (TM) system used for NQR spectroscopy."
+description = "A module for the NQRduck program (a simple python script™) for automatic Tuning and Matching (TM) system used for magnetic resonance spectroscopy."
 readme = "README.md"
 license = { file="LICENSE" }
 requires-python = ">=3.8"
@@ -23,7 +23,7 @@ classifiers = [
 dependencies = [
     "matplotlib",
     "pyqt6",
-    "NQRduck",
+    "nqrduck",
     "pyserial",
 ]