Pypi readme (#133)

* Added README_pypi.md generation

* Upversioned to 1.6.1

Author: JamesPicoTech

.github/workflows/python-build-publish.yml

@@ -29,6 +29,11 @@ jobs:
         python -m pip install pytest build
         # pip install -r requirements.txt  # Install your dependencies
 
+    - name: Create pypi README.md
+      run: |
+        python build-tools\build_pypi_doc.py
+        dir
+
     - name: Create SDK directory
       shell: pwsh
       run: |

README.md

@@ -47,6 +47,6 @@ Current PicoScope support:
 - [pypi-nightly (dev repo)](https://pypi.org/project/pypicosdk-nightly/)
 
 ## Version Control
-pyPicoSDK: 1.6.0
+pyPicoSDK: 1.6.1
 
 Docs: 0.4.0

build-tools/build_pypi_doc.py

@@ -0,0 +1,20 @@
+# pylint: skip-file
+# flake8: noqa
+import re
+
+string = '<!-- start here -->'
+string_len = len(string)
+with open('README.md') as f:
+    readme = f.read()
+
+index = readme.find(string) + string_len + 1
+img_str = '''<p align="center">
+  <img src="https://raw.githubusercontent.com/JamesPicoTech/pyPicoSDK/refs/heads/main/docs/docs/img/pypicosdk-light-300x300.png" alt="Fancy logo">
+</p>
+
+'''
+
+new_readme = img_str + readme[index:]
+
+with open('README_pypi.md', 'w') as f:
+    f.write(new_readme)

pypicosdk/version.py

@@ -1,2 +1,2 @@
 
-VERSION = "1.6.0"
+VERSION = "1.6.1"

pyproject.toml

@@ -13,7 +13,7 @@ keywords = [
     "electronic"
 ]
 description = "Modern Python wrapper for PicoSDK"
-readme = "README.md"
+readme = "README_pypi.md"
 requires-python = ">=3.10"
 license = { file = "LICENSE" }
 authors = [

version.py

@@ -1,4 +1,4 @@
 # Master version file for all scripts.
 # Update these variables and run a build-tool (which will run version_updater.py)
 docs_version = "0.4.0"
-package_version = "1.6.0"
+package_version = "1.6.1"