Initial commit

Author: alex-dewar

.github/workflows/publish-to-test-pypi.yml

@@ -0,0 +1,22 @@
+name: Pub Python dist to TestPyPi
+
+on: push
+
+jobs:
+    build-n-publish:
+      name: Build/pub python to testpypi
+      runs-on: ubuntu-18.04
+      steps:
+        - uses: actions/checkout@master
+        - name: Setup Python 3.7
+          uses: actions/setup-python@v1
+          with:
+            python-version: 3.7
+        - name: Build ChipShover
+          run: >-
+            python host-python/setup.py sdist
+        - name: Publish to pypi
+          if: startsWith(github.ref, 'refs/tags')
+          uses: pypa/gh-action-pypi-publish@master
+          with:
+            password: ${{ secrets.py_pi_deploy }}

LICENSE renamed to LICENSE.txt

@@ -1,3 +1,4 @@
+
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/

README.md

@@ -0,0 +1,28 @@
+# ChipShover®
+
+ChipShover is an XYZ table & driver, with handy Python interface. It's designed for close analysis of ICs using tools like Electromagnetic Fault Injection (EMFI), EM Probes for side-channel, and more. In both specifications and cost it falls somewhere between between 3D printers & microscope stages.
+
+## Python Interface
+
+A Python interface simplifies use from existing Jupyter notebooks and similar.
+
+Here is an example usage to sweep an IC surface from (10.0, 10.0) to (12.5, 12.5) in 0.05mm steps. Also plunge the Z-axis down to touch a probe to the surface at each location (useful when probe cannot be dragged across surface safely).
+
+	from chipshover import ChipShover
+
+	shv = ChipShover('com3')
+
+	shv.home()
+
+	for x,y in shv.sweep_x_y(10, 12.5, 10, 12.5, step=0.05, z_plunge=1.5):
+	    print("At %f, %f"%(x,y))
+
+## Installing ChipShover Python
+
+Install `chipshover` like any other Python package. It should be available on [pypi.org](https://pypi.org/project/chipshover/) so you can do:
+
+	pip install chipshover
+
+## Full Python Documentation
+
+See [chipshover.readthedocs.io](http://chipshover.readthedocs.io/) for the full API documentaiton (auto-built from Python).

chipshover/__init__.py

@@ -0,0 +1,2 @@
+from .cs import *
+from .cs import firmware_update