Merge pull request #48 from MatthewCroughan/packaging

add packaging details for jupyter_micropython_kernel module

README.md

@@ -12,7 +12,15 @@ for examples.
 First install Jupyter: http://jupyter.org/install.html (the Python3 version).
 **They strongly recommended you use the [Anaconda Distribution](https://www.anaconda.com/download/)**
 
-Then clone this repository to a directory using TortoiseGIT or with the shell command (ie on a command line):
+### Via PyPi
+
+```
+pip install jupyter_micropython_kernel
+python -m jupyter_micropython_kernel.install
+```
+### Manual Installation
+
+Clone this repository to a directory using TortoiseGIT or with the shell command (ie on a command line):
 
     git clone https://github.com/goatchurchprime/jupyter_micropython_kernel.git
 
@@ -25,7 +33,6 @@ directory, and makes it possible to "git update" the library later as it gets im
 (Things can go wrong here, and you might need "pip3" or "sudo pip" if you have 
 numerous different versions of python installed
 
-
 Install the kernel into jupyter itself using the shell command:
 
     python -m jupyter_micropython_kernel.install
@@ -33,11 +40,12 @@ Install the kernel into jupyter itself using the shell command:
 (This creates the small file ".local/share/jupyter/kernels/micropython/kernel.json" 
 that jupyter uses to reference it's kernels
 
+### Post-Install
+
 To find out where your kernelspecs are stored, you can type:
 
     jupyter kernelspec list
 
-
 ## Running
 
 Now run Jupyter notebooks:

jupyter_micropython_kernel/__init__.py

@@ -0,0 +1,3 @@
+"""Jupyter kernel to interact with a MicroPython ESP8266 or ESP32 over its serial REPL."""
+
+__version__ = '0.1.3.2'

pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["flit_core >=2,<4"]
+build-backend = "flit_core.buildapi"
+
+[tool.flit.metadata]
+module = "jupyter_micropython_kernel"
+description-file = "README.md"
+author = "Julian Todd, Tony DiCola"
+author-email = "julian@goatchurch.org.uk"
+home-page = "https://github.com/goatchurchprime/jupyter_micropython_kernel"
+requires-python=">=3.0"
+requires=[
+    "pyserial>=3.4",
+    "websocket-client>=0.44"
+]
+classifiers=[
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]

setup.py

@@ -1,14 +0,0 @@
-from setuptools import setup
-
-setup(name='jupyter_micropython_kernel',
-      version='0.1.3',
-      description='Jupyter notebook kernel for operating Micropython.',
-      author='Julian Todd, Tony DiCola',
-      author_email='julian@goatchurch.org.uk',
-      keywords='jupyter micropython',
-      url='https://github.com/goatchurchprime/jupyter_micropython_kernel',
-      license='GPL3',
-      packages=['jupyter_micropython_kernel'],
-      install_requires=['pyserial>=3.4', 'websocket-client>=0.44']
-)
-