Install Jupyter kernel when --enable-editable is in use

[mkoeppe]

When --enable-editable is in use, the Jupyter kernel sagemath is not being installed.

Workaround for users:

• Either install without --enable-editable first
• Or fix it using: ./sage -python -c 'from sage.repl.ipython_kernel.install import SageKernelSpec; SageKernelSpec.update()'

---

In this ticket, we fix it by adding a custom develop command.

(In follow up ticket #30298, the jupyter kernel (but without the symlink doc -- which cannot and should not be stored in a wheel!) will also be added as data_files - and thus be available in all types of installations - setup.py install, wheel-based, and editable)

CC: @tobiasdiez @dimpase @kiwifb @antonio-rojas @egourgoulhon

Component: build

Author: Matthias Koeppe

Branch/Commit: 4473375

Reviewer: Tobias Diez

Issue created by migration from https://trac.sagemath.org/ticket/33855

[mkoeppe]

comment:1

Some related tickets: #30298, #30124, #31156, #31157, #30306, #33651

[mkoeppe]

Author: Matthias Koeppe

[mkoeppe]

Branch: u/mkoeppe/install_jupyter_kernel_when___enable_editable_is_in_use

[mkoeppe]

comment:4

Here's some preparation, split out from #32927.

---

New commits:

99038d1

src/sage_setup/command/sage_install.py: Split sage_install_and_clean into several classes

[mkoeppe]

Commit: 99038d1

[mkoeppe]

comment:5

The kernel might also be missing in the wheels. Best to redo the kernelspec generation/installation similar to https://github.com/ipython/ipykernel/blob/main/setup.py#L108

[mkoeppe]

Changed author from Matthias Koeppe to Matthias Koeppe, ...

[mkoeppe]

comment:6

When building a wheel, the symlink doc must be omitted but the other files should be listed as data_files.

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

6c5903d	src/sage_setup/command/sage_install.py: Split sage_install_and_clean into several classes
40b44a1	build/pkgs/sagelib/spkg-install: Do installation of sagemath kernelspec here, not in sage_setup.command.sage_install

[sagetrac-git]

Changed commit from 99038d1 to 40b44a1

[mkoeppe]

comment:8

Replying to @mkoeppe:

When building a wheel, the symlink doc must be omitted but the other files should be listed as data_files.

I'll do this in #30298 as a follow-up.

Here's a simple solution that will suffice for #33739

[sagetrac-git]

Changed commit from 40b44a1 to 1c1dbc5

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

1c1dbc5

src/setup.py: No need to use custom sage_install

[sagetrac-git]

Changed commit from 1c1dbc5 to 6862287

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

6862287

build/pkgs/sagelib/spkg-install: Un-poison SAGE_DOC for installing the kernelspec

[mkoeppe]

Changed author from Matthias Koeppe, ... to Matthias Koeppe

[slel]

comment:13

Possibly related question:

• Ask Sage question 62472: Sage not listed in Jupyter kernels

[mkoeppe]

comment:14

Yes, that's the same issue

[tobiasdiez]

comment:16

As you observe in #33739, this doesn't work if one simply uses pip to editable install sagelib. To also support this, I propose to run the kernelspec install as a custom develop cmdclass, similar to how it is currently done for install (extracting the kernelspec things to a mixin that can be reused). This seams to be a fairly standard way of doing it: https://github.com/search?q=kernelspec+develop++filename%3Asetup.py&type=code

[mkoeppe]

comment:17

Yes, this sounds like a good approach. Do you want to push to the ticket? I'm working on something else right now

[tobiasdiez]

comment:18

No, I sadly don't have time for this atm.

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

6c5903d	src/sage_setup/command/sage_install.py: Split sage_install_and_clean into several classes
4473375	src/sage_setup/command/sage_install.py: Add sage_develop, use it in src/setup.py, pkgs/sagemath-standard/setup.py

[sagetrac-git]

Changed commit from 6862287 to 4473375

[mkoeppe]

comment:24

Replying to @tobiasdiez:

I propose to run the kernelspec install as a custom develop cmdclass

Re-done as you suggested, works nicely.

[tobiasdiez]

Reviewer: Tobias Diez

[tobiasdiez]

comment:25

Thanks. Code looks good to me and it seems to work (tested using #33739).

[mkoeppe]

comment:26

Thanks!

[kiwifb]

comment:27

This ticket may conflict with a number of others touching the same files either in the same location or nearby locations. So some dependencies/merge order will have to be established. #32927 is already mentioned so I guess it is alright but #33838 may also clash.

[mkoeppe]

comment:28

Test merge with #33838 succeeds without conflict

[kiwifb]

comment:29

That's great, are you aware of any other tickets that touches setup.pys?

[mkoeppe]

comment:30

You are asking for tickets to review next? #28925

[vbraun]

Changed branch from u/mkoeppe/install_jupyter_kernel_when___enable_editable_is_in_use to 4473375