This kernel adds support for Elm to [Jupyter](http://jupyter.org/) notebooks.
While basic functionality is in place, this is still very much a work in progress. I’m still figuring it all out. Any help, ideas, etc. would be great.
# Requirements - Python 3.6+
# Installation
Either install from a repository using pip:
` pip install elm_kernel `
or install the package from source:
` pip install -e . `
Then install the kernel spec: ` python -m elm_kernel.install `
# Usage
Run jupyter notebook and select the Elm kernel for a new notebook.
## Multi-cell code examples
By default, when you execute a code cell with the Elm kernel the code will not be compiled. Instead, the kernel simply queues up code cells. This way you can break longer examples over multiple cells, interleaving the code cells with supporting Markdown cells.
In order to ask the kernel to actually compile your code, you need to terminate a code cell with the line:
` -- compile-code `
When the kernel sees a cell like this it contatenates, in cell-execution order, all of the executed but uncompiled code cells (i.e. everything since the start of the kernel or the last – compile-code cell). It then compiles the concatenated code, returning the result to the notebook.
For a concrete example of this, see [examples/the-elm-architecture.ipynb](https://github.com/abingham/jupyter-elm-kernel/blob/master/examples/the-elm-architecture.ipynb).
This is a bit hacky, and we’re actively searching for a better alternative. Ideas are welcome!
# Examples
The examples directory contains a few examples of how to use this kernel. Just go to that directory and run jupyter notebook to see them.
Metadata
Release files for elm-kernel 0.21.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| elm_kernel-0.21.1.tar.gz | 5.0 kB | Without provenance | Details for elm_kernel-0.21.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| elm_kernel-0.21.1-py3-none-any.whl | Python 3 | none | any | Details for elm_kernel-0.21.1-py3-none-any.whl |
Total release size: 11.7 kB
Release files / elm_kernel-0.21.1.tar.gz
| Download URL | elm_kernel-0.21.1.tar.gz |
|---|---|
| Size | 5.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1b617ec9da7a776b054fb545aa843d1d4afca43b06fb708f2345b601e390a249
|
|
BLAKE2b-256 checksum How to use checksums |
e6c0f2b9939e9d5aab94441b95c6fca5115269971b34984c53d8e528145ca8c7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.7.6
|
Release files / elm_kernel-0.21.1-py3-none-any.whl
| Download URL | elm_kernel-0.21.1-py3-none-any.whl |
|---|---|
| Size | 6.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b5e923592f06938708b3f7ae498c8b819df6659311f61085f180782ee9d6363f
|
|
BLAKE2b-256 checksum How to use checksums |
3aaec5539d0cced446e1734666cca0f5391af159b028088dbaea841a8d4270c7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.7.6
|
Security for elm-kernel 0.21.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.