Skip to content
Jupyter kernel to interact with CircuitPython board over USB
Python Makefile
Branch: master
Clone or download
Pull request Compare This branch is 14 commits ahead, 44 commits behind willingc:master.
brentru Merge pull request #19 from CapableRobot/perf
Performance improvement by not sending no-op lines
Latest commit 934dd06 Dec 28, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add initial cookiecutter project structure Mar 23, 2017
circuitpython_kernel Change from method to function per pylint Dec 21, 2018
docs Update environment.yml to satisfy RTD Jul 3, 2018
examples
tests Remove tox temporarily Mar 24, 2017
.editorconfig Add initial cookiecutter project structure Mar 23, 2017
.gitignore Softreset Magic, bugfixes (#17) Nov 27, 2018
.pylintrc Edit style to comply with black codestyle (#11) Jun 20, 2018
.travis.yml Update support for 3.6 and higher" (#10) Jun 18, 2018
AUTHORS.rst Read The Docs Update (#6) (#7) Jun 14, 2018
CONTRIBUTING.rst Update support for 3.6 and higher" (#10) Jun 18, 2018
HISTORY.rst bump version for release Nov 27, 2018
LICENSE Add initial cookiecutter project structure Mar 23, 2017
MANIFEST.in Add initial cookiecutter project structure Mar 23, 2017
Makefile Remove tox temporarily Mar 24, 2017
README.rst Update README.rst to reflect current CPY version Nov 27, 2018
readthedocs.yml Add conda build for docs Mar 24, 2017
requirements_dev.txt Contact Info __init__.py (#13) Jun 19, 2018
setup.cfg bump version for release Nov 27, 2018
setup.py bump version for release Nov 27, 2018
travis_pypi_setup.py

README.rst

CircuitPython Kernel

https://cdn-learn.adafruit.com/guides/images/000/002/051/medium310/Untitled-3.png?1528919538

Documentation Discord Build Status

The CircuitPython Kernel is a Jupyter Kernel designed to interact with Adafruit boards running CircuitPython from within a Jupyter Notebook.

Status

This project's status is experimental. It has been tested with CircuitPython (SAMD) boards and the Feather HUZZAH (ESP8266) with CircuitPython 3.x.

It may break, and if it does, please file an issue on this repository.

Compatible Boards

Designed for CircuitPython (SAMD21 and SAMD51)

Other Adafruit Boards

Download

Official .zip files are available through the latest GitHub releases.

Install

Jupyter:

pip3 install --upgrade pip
pip3 install jupyter

Optional:

pip3 install jupyterlab

CircuitPython kernel:

cd circuitpython_kernel/
python3 setup.py install; python3 -m circuitpython_kernel.install

Then run with one of:

jupyter notebook
jupyter lab

and choose the CircuitPython kernel.

Documentation

This kernel is fully documented on the Adafruit Learning System Guide: CircuitPython with Jupyter Notebooks.

A line containing exactly the word:

%softreset

will reset the board and release all resources.

There's also documentation for this kernel listed on ReadTheDocs.

You can’t perform that action at this time.