Modifying the Dynamic Buttons in the Notebook Server

[Ian Stuart]

I have a need to write an extension to the notebook server which is triggered by a button in the  dynamic-buttons div.

There are two, maybe three, parts to this question.

1) I've read http://mindtrove.info/4-ways-to-extend-jupyter-notebook/#nb-server-exts - but where does this code & how do I install it?

2) Are there any examples of Server extensions I can explore?

3) Is there any more expansive documentation? ---- for the server extensions, not the notebook extensions

Cheers.

[Thomas Kluyver]

On 25 January 2018 at 16:50, 'Ian Stuart' via Project Jupyter <jup...@googlegroups.com> wrote:

1) I've read http://mindtrove.info/4-ways-to-extend-jupyter-notebook/#nb-server-exts - but where does this code & how do I install it?

The code goes anywhere that it can be imported from Python - typically you'd make a package which can be installed with pip.

 

2) Are there any examples of Server extensions I can explore?

Cite2c adds some URL handlers with a server extension:

https://github.com/takluyver/cite2c/blob/master/cite2c/handlers.py

And the docs show the files for a simple server extension:

http://jupyter-notebook.readthedocs.io/en/stable/examples/Notebook/Distributing%20Jupyter%20Extensions%20as%20Python%20Packages.html#Example---Server-extension

 

3) Is there any more expansive documentation? ---- for the server extensions, not the notebook extensions

I think this is what there is:

http://jupyter-notebook.readthedocs.io/en/stable/extending/handlers.html

[Ian Stuart]

On 27 January 2018 at 10:03, Thomas Kluyver <tak...@gmail.com> wrote:

On 25 January 2018 at 16:50, 'Ian Stuart' via Project Jupyter <jup...@googlegroups.com> wrote:

2) Are there any examples of Server extensions I can explore?

Cite2c adds some URL handlers with a server extension:

https://github.com/takluyver/cite2c/blob/master/cite2c/handlers.py

These seem to be handlers within the notebook itself - I'm looking to add handlers for actions in the _tree_ page (ie, when I user selects a file/directory, an additional button appears [depending on stuff, which I need to code]

The Jupyter code is in here: https://github.com/jupyter/jupyter_server/blob/dd4b052403cc0ce70dbde9bfc6c71d6b09e814ec/notebook/static/tree/js/notebooklist.js

 

And the docs show the files for a simple server extension:

http://jupyter-notebook.readthedocs.io/en/stable/examples/Notebook/Distributing%20Jupyter%20Extensions%20as%20Python%20Packages.html#Example---Server-extension

Thankee....

--

Ian

[Thomas Kluyver]

If you want to do things in the Javascript, that's a notebook extension (aka nbextension) rather than a server extension. You might need a corresponding server extension for your new buttons to talk to (cite2c is an example of an extension that contains both an nbextension and a server extension).

Here's an example of an extension modifying the tree view:
http://jupyter-contrib-nbextensions.readthedocs.io/en/latest/nbextensions/tree-filter/readme.html
https://github.com/ipython-contrib/jupyter_contrib_nbextensions/blob/master/src/jupyter_contrib_nbextensions/nbextensions/tree-filter/index.js

It works the same way as an nbextension modifying the notebook page, but you have to make sure it's enabled for the tree view.

Thomas

--
You received this message because you are subscribed to the Google Groups "Project Jupyter" group.
To unsubscribe from this group and stop receiving emails from it, send an email to jupyter+unsubscribe@googlegroups.com.
To post to this group, send email to jup...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/jupyter/CAKofB1LeB1jRFZh6CFOFBT6KbB_gjAmemEP7_idqjoRJ5zEOdA%40mail.gmail.com.

For more options, visit https://groups.google.com/d/optout.

[Ian Stuart]

On 29 January 2018 at 09:20, Thomas Kluyver <tak...@gmail.com> wrote:

If you want to do things in the Javascript, that's a notebook extension (aka nbextension) rather than a server extension. You might need a corresponding server extension for your new buttons to talk to (cite2c is an example of an extension that contains both an nbextension and a server extension).

Here's an example of an extension modifying the tree view:
http://jupyter-contrib-nbextensions.readthedocs.io/en/latest/nbextensions/tree-filter/readme.html
https://github.com/ipython-contrib/jupyter_contrib_nbextensions/blob/master/src/jupyter_contrib_nbextensions/nbextensions/tree-filter/index.js

It works the same way as an nbextension modifying the notebook page, but you have to make sure it's enabled for the tree view.

Spot on!

Thank you...

 

--

Ian