Pypi README fix (#134)

* Fix pypi readme

* Upversioned to 1.6.1

Author: JamesPicoTech

build-tools/version_updater.py

@@ -11,6 +11,26 @@
 sys.path.append(parent_dir)
 from version import docs_version, package_version
 
+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>
+
+'''
+
+def build_pypi_doc():
+    "Create a pypi readme"
+    string = '<!-- start here -->'
+    string_len = len(string)
+    with open('README.md') as f:
+        readme = f.read()
+
+    index = readme.find(string) + string_len + 1
+
+    new_readme = IMG_STR + readme[index:]
+
+    with open('pypi.md', 'w') as f:
+        f.write(new_readme)
+
 
 def update_lines(file_path, start_with, replacement_string):
     with open(file_path, 'r') as f:
@@ -35,4 +55,5 @@ def update_versions():
     update_src()
 
 if __name__ == "__main__":
-    update_versions()
+    update_versions()
+    build_pypi_doc()

pypi.md

@@ -0,0 +1,50 @@
+<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>
+
+# Welcome to pyPicoSDK Documentation
+## Installation
+### Prerequisites 
+1. Go to PicoTech downloads [picotech.com/downloads](https://www.picotech.com/downloads)
+2. Find your PicoScope in the list and click through
+3. Download and install PicoSDK for your operating system
+### Via Pip
+1. Install the package via pip `pip install pypicosdk`
+2. In your `main.py` add `import pypicosdk` or `import pypicosdk as psdk`
+
+### Via GitHub (Inc examples)
+1. Install github repository to folder `git clone https://github.com/JamesPicoTech/pyPicoSDK.git`
+2. In the root directory (where setup.py is) run `pip install .`
+3. In your `main.py` add `import pypicosdk` or `import pypicosdk as psdk`
+
+## Quickstart
+To test functionality of this library, copy and run the following python script:
+```
+import pypicosdk as psdk
+
+scope = psdk.ps6000a()
+
+scope.open_unit()
+print(scope.get_unit_serial())
+scope.close_unit()
+```
+The output should be similar to:
+`JR001/001`
+
+Once tested, try an [example script from github](https://github.com/JamesPicoTech/pyPicoSDK) to get started.
+
+## Compatibility
+Current PicoScope support:
+- PicoScope 6000E (ps6000a drivers)
+- PicoScope 3000E (psospa drivers)
+
+## Useful links and references
+- [Documentation & Reference](https://jamespicotech.github.io/pyPicoSDK/)
+- [GitHub Repo (with examples)](https://github.com/JamesPicoTech/pyPicoSDK)
+- [pypi (src repo)](https://pypi.org/project/pypicosdk/)
+- [pypi-nightly (dev repo)](https://pypi.org/project/pypicosdk-nightly/)
+
+## Version Control
+pyPicoSDK: 1.6.1
+
+Docs: 0.4.0

pyproject.toml

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