File tree Expand file tree Collapse file tree 2 files changed +19
-1
lines changed Expand file tree Collapse file tree 2 files changed +19
-1
lines changed Original file line number Diff line number Diff line change @@ -184,3 +184,20 @@ To start the terminal console or the Qt console with a specific kernel::
184
184
185
185
The notebook offers you the available kernels in a dropdown menu from the 'New'
186
186
button.
187
+
188
+
189
+ .. _packaging-kernels :
190
+
191
+ Packaging
192
+ =========
193
+
194
+ To release your kernel as a Python package, we recommend following the pattern
195
+ used in the :ref: `echo_kernel `, which uses the `hatch `_ build backend and
196
+ a build file that creates the kernel directory with the ``kernel.json `` and
197
+ kernel icons, which is included as ``shared-data ``, ending up in the
198
+ ``share/jupyter/kernels/ `` folder in the user's installed environment.
199
+ See `pyproject.toml `_ and `hatch_build.py `_ for more details.
200
+
201
+ .. _hatch : https://hatch.pypa.io/latest/
202
+ .. _pyproject.toml : https://github.com/jupyter/echo_kernel/blob/main/pyproject.toml
203
+ .. _hatch_build.py : https://github.com/jupyter/echo_kernel/blob/main/hatch_build.py
Original file line number Diff line number Diff line change @@ -19,6 +19,7 @@ also has a ``ProcessKernel`` subclass that makes it easy to write kernels that
19
19
use ``pexpect ``.
20
20
See `Octave Kernel <https://github.com/Calysto/octave_kernel >`_ as an example.
21
21
22
+ If releasing a wrapper kernel as a Python package, see the steps in :ref: `packaging-kernels `.
22
23
23
24
Required steps
24
25
--------------
@@ -86,7 +87,7 @@ Example
86
87
87
88
.. seealso ::
88
89
89
- `echo_kernel <https://github.com/jupyter/echo_kernel >`__
90
+ `echo_kernel <https://github.com/jupyter/echo_kernel >`_
90
91
A packaged, installable version of the condensed example below.
91
92
92
93
``echokernel.py `` will simply echo any input it's given to stdout::
You can’t perform that action at this time.
0 commit comments