Kernelspec JSON schema

[JohanMabille]

Kernelspec JSON schema

This proposes to specify the kernelspec through a JSON schema, and have the specification and documentation live in a dedicated repo.

The JSON schema is joined as a standalone file.

Voting from @jupyter/software-steering-council

Like #106 , let's move to the voting phase. As said in this comment, future schema should not be JEPs, but PR open to the Jupyter Schema repo

• @gabalafou
  • [x] Yes
  • [ ] No
  • [ ] Abstain
• @ivanov
  • [x] Yes
  • [ ] No
  • [ ] Abstain
• @JohanMabille
  • [x] Yes
  • [ ] No
  • [ ] Abstain
• @jtpio
  • [x] Yes
  • [ ] No
  • [ ] Abstain
• @marthacryan
  • [x] Yes
  • [ ] No
  • [ ] Abstain
• @martinRenou
  • [x] Yes
  • [ ] No
  • [ ] Abstain
• @minrk
  • [x] Yes
  • [ ] No
  • [ ] Abstain
• @rpwagner
  • [x] Yes
  • [ ] No
  • [ ] Abstain
• @SylvainCorlay
  • [x] Yes
  • [ ] No
  • [ ] Abstain
• @vidartf
  • [ ] Yes
  • [ ] No
  • [ ] Abstain

[Zsailer]

Thank you for doing this @JohanMabille! You beat me to it. I had spent some time yesterday writing the exact same JEP as an action item from the SSC meeting. 😅

[JohanMabille]

@Zsailer arf sorry for that! This came out when discussing the Handshake pattern, we need an additional field in the kernelspec and I thought it could be the opportunity to add a schema for it. I'll be more careful next time to avoid doing the work twice!

[Zsailer]

@Zsailer arf sorry for that! This came out when discussing the Handshake pattern, we need an additional field in the kernelspec and I thought it could be the opportunity to add a schema for it. I'll be more careful next time to avoid doing the work twice!

No no no—this is fantastic! I really appreciate you taking this over! No need to apologize 😃

[Zsailer]

I think it's worth saying for voting purposes—I'm :+1: for this JEP getting accepted.

We can continue to copy-edit, but wanted to explicitly submit my support. 😃

[JohanMabille]

More changes to come, but I need to educate myself more to JSON schemas :sweat_smile:

[westurner]

• [ ] BLD,SCH: CI task to run e.g. js2shacl to generate W3C SHACL from the kernelspec JSON schema

https://github.com/ThiagoCComelli/JS2SHACL-JSON-Schema-to-SHACL-conversor/blob/master/conversor.js

IDK why SHACL also yet, but there's a converter

On Mon, Nov 20, 2023, 10:03 AM Frédéric Collonval @.***> wrote:

@.**** commented on this pull request.

In kernelspec-spec/kernelspec.schema.json https://github.com/jupyter/enhancement-proposals/pull/105#discussion_r1399334630 :

• "required": ["language"],
• "properties": {
• "language": {
• "description": "The name of the language of the kernel. When loading notebooks, if no matching kernelspec key (may differ across machines) is found, a kernel with a matching language will be used. This allows a notebook written on any Python or Julia kernel to be properly associated with the user’s Python or Julia kernel, even if they aren’t listed under the same name as the author’s.",
• "type": "string"
• }
• }
• },
• "kernel_protocol_version": {
• "type": "object",
• "required": ["kernel_protocol_version"],
• "properties": {
• "kernel_protocol_version": {
• "description": "The version of protocol this kernel implements. If not specified, the client will assume the version is <5.5 until it can get it via the kernel_info request. The kernel protocol uses semantic versioning (SemVer).",
• "type": "string",
• "pattern": "^(0|[1-9]\d).(0|[1-9]\d).(0|[1-9]\d)(?:-((?:0|[1-9]\d|\d[a-zA-Z-][0-9a-zA-Z-])(?:.(?:0|[1-9]\d|\d[a-zA-Z-][0-9a-zA-Z-]))))?(?:+([0-9a-zA-Z-]+(?:.[0-9a-zA-Z-]+)*))?$"

⬇️ Suggested change

• "pattern": "^(0|[1-9]\d).(0|[1-9]\d).(0|[1-9]\d)(?:-((?:0|[1-9]\d|\d[a-zA-Z-][0-9a-zA-Z-])(?:.(?:0|[1-9]\d|\d[a-zA-Z-][0-9a-zA-Z-]))))?(?:+([0-9a-zA-Z-]+(?:.[0-9a-zA-Z-]+)*))?$"
• "pattern": "^(0|[1-9]\d)\.(0|[1-9]\d).(0|[1-9]\d)(?:-((?:0|[1-9]\d|\d[a-zA-Z-][0-9a-zA-Z-])(?:\.(?:0|[1-9]\d|\d[a-zA-Z-][0-9a-zA-Z-]))))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"

— Reply to this email directly, view it on GitHub https://github.com/jupyter/enhancement-proposals/pull/105#pullrequestreview-1740034561, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAMNS7LNV3B4W35OUUIJZDYFNWNVAVCNFSM6AAAAAAXEDPL7CVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMYTONBQGAZTINJWGE . You are receiving this because you are subscribed to this thread.Message ID: @.***>

[JohanMabille]

Kind ping on this, I think this is ready for a final review:

• The Jupyter Schema repo has been created, it will hold all the schemas for Project Jupyter and the JEP has been updated accodingly (not more specific repo per spec)
• While the first schema specifications have been proposed through JEPs, the recent works and meetings of the Jupyter Contributors involved in the schema specifications led to the conclusion that we could directly work on the Jupyter Schema repo: implement first versions of different schema and then have fast iterations to make them more robust and extract common parts into dedicated schema. This would streamline the process.

[JohanMabille]

The JEP has been approved.

Yes: 9 No: 0 Abstention: 0 No vote: 1

Merging