shim connecting Jupyter to a HomeAssistant Pyscript kernel
Project homepage: https://github.com/craigbarratt/hass-pyscript-jupyter
Description
The Pyscript add-on for HomeAssistant ('HASS pyscript') provides a "kernel"
that interfaces with the Jupyter front-ends (e.g. notebook, console, lab, and
also VSCode). It allows you to develop and test pyscript triggers, functions
and automation logic interactively, and interact with much of HASS by looking
at state variables and calling services as you experiment and develop your
own logic and automations.
While HomeAssistant does not easily run on OpenBSD, you can run it on another
system and connect from the Jupyter front-ends running on OpenBSD by using
this package, hass-pyscript-jupyter, which provides a shim that sits between
HASS pyscript and Jupyter. This shim is started by Jupyter and uses the HASS
web interface to make a service call to pyscript, starting the kernel and
helping establish the various socket connections between HASS/pyscript and
Jupyter.
The end result is that you can interact with Python/pyscript on HASS from an
OpenBSD system.
Package information
- Ports path
- devel/py-hass-pyscript-jupyter
- Package architecture
- amd64
- Maintainer
- The OpenBSD ports mailing-list <ports@openbsd.org>
- Categories
- devel, lang/python
- Available flavors
- None listed
- Only for architectures
- aarch64, amd64, arm, i386, mips64, mips64el, powerpc, powerpc64, riscv64, sparc64, alpha, hppa
Ports list build and test dependencies as well as runtime dependencies. pkg_add selects those needed for installation.
Direct dependencies
Runtime
Build
- lang/python/3
- devel/py-build
- devel/py-installer
- devel/py-setuptools py3-setuptools->=79v0
- devel/py-wheel
OpenBSD README
This README contains unresolved ports variables; replace them before using its commands.
+-------------------------------------------------------------------------------
| Running py3-hass-pyscript-jupyter on OpenBSD
+-------------------------------------------------------------------------------
Note that HomeAssistant (HASS) does not easily run on OpenBSD; this package
is for connecting to Pyscript running on HASS on another system.
Firstly you'll need to install Pyscript on your HASS system, manually or
via HACS, and then add it as an integration via the HASS config interface.
This is outside the scope of this readme; see the documentation at
https://hacs-pyscript.readthedocs.io/en/stable/installation.html for more.
You will also need to create a long-lasting access token for your HASS user.
This is done in the security tab of the user page. When you have this,
edit ${TRUEPREFIX}/share/jupyter/kernels/pyscript/pyscript.conf, configure
'hass_host' and 'hass_url' as appropriate, and paste in the access token.
The token provides access to HASS, so be sure to set file ownership and
permissions as appropriate.
You can then access this via Jupyter notebook, for example:
# pkg_add jupyter-notebook
$ jupyter notebook ${TRUEPREFIX}/share/doc/hass-pyscript-jupyter
Then open a web browser pointing at the local server as directed (if one
is not started automatically), and work through pyscript_tutorial.ipynb.
You can also open a console to the Pyscript "kernel" and issue commands
directly.
Also see ${TRUEPREFIX}/share/doc/hass-pyscript-jupyter/README.md.