Jupyter Notebooks Extensions

Thanks for the quick tutorial

Is there a way I can export the notebook without the python code appearing in the export? for e.g. something like you can do with R Studio wherein you can create R Markdown presentations with charts and user written comments in markdown, but turn off the R code from printing in the final document/presentation which generated the charts?

Thank you for a nice and brief tutorial. Great one!

very informative .. Thanks!!

Thank you for the excellent tutorial. Will be using the extensions knowledge I have gained in future development.

I dont know why I can see nbextensions after installing it

Try to restart Jupyter notebooks from the command line after installing nbextensions.

Hi Martin,

My name is Lipsa and i am absolute beginner. i may ask may questions, i hope its okay. when i am trying to install jupyter in command prompt i get below error.

Microsoft Windows [Version 10.0.18362.476] (c) 2019 Microsoft Corporation. All rights reserved.

C:\Users\Lipsa Patro> pip install command prompt ‘pip’ is not recognized as an internal or external command, operable program or batch file.

C:\Users\Lipsa Patro>

Please advise on same and also share some cool tips.

Hello @Lipsa and welcome to the community :)

This message tells you that you currently don’t have pip installed on your system. You can read more about it here in What is Pip.

This Python 3 Installation & Setup Guide might also be useful. Alternatively, you could install Miniconda that already includes an installation of Jupyter notebooks.

Hope that helps!

Thanks , very helpfull

Hi Martin, I’m not able to view the extensions under the Nbextensions tab. Details below:

• I’ve installed Jyupter notebooks via Anaconda package and after following the commands you’ve given I’ve installed the intended packages.
• After restarting the Jyupter though I can see the intented tab i.e. Nbextensions but I’m not able to see the extensions
• I’m on Windows 10 OS and Notebook version is 6.0.1

Could you guide me or suggest me a way through I can see the intended extensions please ? Let me know in case more details are required from my end.

Hello @Vikrant. Double-check that you installed the package jupyter_contrib_nbextensions and that you have activated at least one of the extensions with jupyter nbextension enable EXTENSION_NAME. See also the section in our written tutorial.

Since you might not know the name of the extension you want to enable beforehand, I suggest to use the Jupyter Nbextensions Configurator (as described in the video). If you install and enable it, you should be able to see all the extensions that came with the package you installed previously. Hope this helps!

Thanks I was able to resolve the issue. Basically, I had duplicate extenstions. However, I’d like to know if you have checkbox i.e. disable configuration for nbextensions without explicit compatibility (they may break your notebook environment, but can be useful to show for nbextension development) in unchecked state to use the extensions?

github.com/ipython-contrib/jupyter_contrib_nbextensions/issues/1459 answer this guy to since nobody else will!

Yes, that checkbox:

disable configuration for nbextensions without explicit compatibility (they may break your notebook environment, but can be useful to show for nbextension development

currently needs to be unchecked so that you can use the extensions.

Thanks Martin but the box is unticked. Im just guessing the anaconda package includes these extensions and I just doubled them? Thank you for reporting back Vikrant I will see if I have doubles…

@mrx In case you’re also running Jyputer via Anaconda then probably it’s worth checking the error logs on the terminal (Jupyter Notebook (Anaconda3): in my case) for any errors i.e. duplicates.

It took me an hour to figure out the issue. docs.anaconda.com/anaconda/user-guide/tasks/use-jupyter-notebook-extensions/#obtaining-the-extensions

Basically I had two issues. 1st the exentions were not available under the intended tab 2. After following the instructions provided in this tutorial correctly I was able to view the extentions however they were disabled.

Upon checking logs on the anaconda terminal I figured out that I had dupicates and I was able to remove them via uninstall command following the instructions provided in the above link

I hope this would help in troubleshooting the issue related to duplicates. Also, in case anybody has installed Jyputer via Anaconda then I believe they have to just enabled the Tab as the extensions are already present (no need to download)

Martin : Please correct me in case I’m wrong with my analysis. Also, if you could add somewhere in the tutorial i.e. how to enable the extensions in case users are using Anaconda installtion for running the jyputer then I believe it would be helpful for the students.

@Vikrant Your awesome, I think people are going to benefit from your solution! I had the same thing going on, but when I started out here I plugged in a USB HDD and installed Ubuntu 18.04 just because I knew I would likely screw things up! So I removed Anaconda and upgraded to 19.04. there was no difference between the package holder .conf and my system.conf, but added the new .conf anyway. I was injured at work, and cannot return to my old job, so with me it is sink or swim!I am going to take the KISS (keep it simple) route and only install what is needed to learn the base language for now (of coarse Jupiter too). I appreciate people like yourself, and Martin (great Tut BTW :) ) If you would like to remove my posts please do so.I will find a seat in the back of the class ;) Happy holidays!

Thanks for your deep-dive with the extension-collision when using the Anaconda Python distribution @Vikrant, and thanks for confirming that Vikrant’s approach resolved your issue as well @mrx. Very helpful 👏!

We’ll add a note to this tutorial section to inform others about this situation. :)

I think it woud be helpful to have an in-depth tutoril on Jupyter Notebook . This was good but would like more information.

Hi Martin. Would you provide the command to restart Jupyter Notebook from command line, please?

Hi @kwf777. We have a in-depth tutorial on Jupyter Notebook’s here: realpython.com/jupyter-notebook-introduction/

Hi @pashikkalenik. You can go into your command line and press Ctrl+c to stop the Notebook Server. Then you can restart it with the normal start command:

jupyter notebook

Hi,

How to end a jupyter notebook when I run it locally and when shall I use the “Quit” and “Logout” button?

Best regards, Thomas

Hi @thomas. There really are a couple of options here and they can be confusing. Here’s what I think:

Terminal

When running your notebook server locally, you can stop it by pressing Ctrl+C in your terminal. This is what I do. It shuts down the whole notebook server and thereby ends your session of working with the any Jupyter app you may have running.

Quit Button

Pressing the “Quit” button is equivalent to shutting down the server through your terminal. When you hover over the button it gives you some info indicating that:

Stop the Jupyter server

Logout Button

This one is a bit more confusing 🤔 It’s easier to understand I think when you think of Jupyter notebooks as a webapp. It runs on a server (whether that’s locally or remotely) and as such you can have sessions that you are logged in to.

When you start a new server locally, it gives you some hints to that effect:

[I 14:34:31.614 NotebookApp] JupyterLab application directory is /your_path
[I 14:34:31.618 NotebookApp] Serving notebooks from local directory: /your_path
[I 14:34:31.618 NotebookApp] The Jupyter Notebook is running at:
[I 14:34:31.618 NotebookApp] http://localhost:8888/?token=9819a2dd9bb34f5844a1e8e0da9fc3d45e55f7cba07411dd
[I 14:34:31.618 NotebookApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).
[C 14:34:31.630 NotebookApp] 

    To access the notebook, open this file in a browser:
        file:///Users/martin/Library/Jupyter/runtime/nbserver-1799-open.html
    Or copy and paste one of these URLs:
        http://localhost:8888/?token=9819a2dd9bb34f5844a1e8e0da9fc3d45e55f7cba07411dd
     or http://127.0.0.1:8888/?token=9819a2dd9bb34f5844a1e8e0da9fc3d45e55f7cba07411dd

Notice the token mentioned here. This token is your login to the notebook server.

Therefore, if you press the “Logout” button, Jupyter brings you to a page that prompts you to log back in (just like a webapp would). You can log back in by copy-pasting the token from your terminal into the input box and voilà you’re back in your notebook session. 🙂

Hi Martin, Thanks for this session. It has been really good. I have one concern. I followed the steps mentioned by you for Nbextensions. I could see the tab for Nbextensions in my Jupyter Home page. But i don’t see any extensions under them.

jupyter-js-widgets/extension

Nbextensions dashboard tab

Nbextensions edit menu item

Hi @prajeecool, did you follow the checks I outlined in a comment further up:

Double-check that you installed the package jupyter_contrib_nbextensions and that you have activated at least one of the extensions with jupyter nbextension enable EXTENSION_NAME. See also the section in our written tutorial.

Since you might not know the name of the extension you want to enable beforehand, I suggest to use the Jupyter Nbextensions Configurator (as described in the video). If you install and enable it, you should be able to see all the extensions that came with the package you installed previously. Hope this helps!

If these steps don’t solve it, please describe in more detail what you did and what you can see and can’t see. We’ll figure it out! :)

Hi Martin,

Thanks for your lesson. I am unable to get the same list of extensions that you had in your video. Please help me. I have explained my situation below.

I followed you all the way until video timestamp 02:04. Up till that point, I had used a terminal in Jupyter to input the following commands: pip install jupyter_contrib_nbextensions pip install jupyter_nbextensions_configurator jupyter nbextensions_configurator enable –user

From 02:04, I was lost. I have no idea how you used your command line to restart Jupyter. I don’t know where is this “command line”; is a command line the same as a terminal that I create in Jupyter? If so, could I have used the same terminal, in which I input the above 3 commands, to execute the Jupyter restart? I also have no idea what commands you input, as seen in 02:18.

As I was unable to locate the command line and restart Jupyter the way you had in the video, what I did was I closed all Jupyter tabs and my Anaconda Navigator as well. I was hoping that this was the same as restarting Jupyter, but it did not work. It did not work because I cannot see the long list of nbextensions.

I also followed @Vikrant’s advice. With reference to docs.anaconda.com/anaconda/user-guide/tasks/use-jupyter-notebook-extensions/#obtaining-the-extensions, I used a Jupyter terminal to input the command “conda install nb_conda”.

The final result was that I only have this extension “Nbextensions edit menu item”, which I don’t know how to use.

Please help me get the same list of extensions as shown in your video. In particular, I am interested in getting the Variable Investigator and Scratch Pad. Thank you.

I second everything that limyuyvette said! I have the exact same issues.

@drcarollmba, let’s hope that Martin helps us soon :) By the way, Martin, to avoid confusion, I am limyuyvette (I recently changed my username to “astrid”).

I believe that Martin had two terminals open. The words “terminal” and “command line” are used interchangeably and (essentially) mean the same thing.

If you you use Anaconda on Windows you can get a command line by starting the Anaconda enabled command prompt, either from the start menu or from within Anaconda Navigator.

If you started Jupyter from within Anaconda Navigator, I don’t think you will have a terminal with the Jupyter log inside (like the one Martin shuts down at about 2:05). Instead, you can restart Jupyter by using the shut-down commands in the menu inside Jupyter. And then starting it again like you usually do - for instance from Anaconda Navigator.

Geir Arne Hjelle, thank you, that helps!

Geir Arne Hjelle, thank you for your help!

For those who still cannot install the nbextensions, you can try this link: www.youtube.com/watch?v=-6HmdijtWwk

I was able to succeed with installation using this link.

Nice tutorial; thank you!

I also encountered an issue with the list of extensions not showing up.

I resolved it by running this command at the terminal after running all of the commands in the video:

jupyter contrib nbextension install --user

From what I understand, the extensions rely on some JavaScript and CSS files that are not automatically installed if you’re not using Anaconda. Running the command above makes sure Jupyter Notebook can find all the resources it needs for the extensions.

Great, thanks for adding this @Melissa Gregoire 👍 : )

Thanks a lot Melissa, I also got stuck with this topic on Mac and jupyter notebook.

@ Martin

Again a very good course - thanks a lot. The django course, indeed very long for a totally newcomer like me, after 4,5 days I check what you did ;)

Man the tutorial was awesome. So if I am using conda I need not install these extentions, these come pre-activated right?

Thanks, @siegikaltmann! Yeah, the Django Intro Course is really long compared to this! :P Glad it helped in the end!

Hi @sreesankar15207, I’m not using Anaconda myself, but from the nb-extensions documentation it seems like you need to install them also when you’re using conda.

I’ve also read in some forums that all the capabilities of nb-extensions is accessible through the Anaconda Navigator, so you might be able to install and activate extensions through that.

Thanks Martin. I am very to have learned about exporting notebooks to py and html files, as well as finding out about jupyter notebook extensions!

Thanks, Martin. Very useful!

I’m using Jupyter in conjunction with another training course (“The Python Workshop”), and this tutorial is WAY more than I knew the program was capable of. What an eye opener! And thanks for keeping it straight forward.

You also responded to some of my questions on “Real Python”, much appreciated.

It was really fantastic & very informative course. Thank you so Much!

Dear Team, Is there any way to convert “.py” file into “.ipynb” format? Thank You in advance!

@aniketbarphe It depends a bit on how you want the .py file to be “translated”. If you want all the content in the .py file into one cell of the notebook, the most straightforward is probably to copy and paste.

For more flexibility, have a look at jupytext.readthedocs.io/ This allows you to translate both ways, and can even keep both files in sync with each other.

Finally, I’ll note that Jupyter Lab allows you to open Notebooks and .py files within the same interface.

Hi @shiningdonkey, @scottbeecher, and @aniketbarphe 👋 Glad you’ve found the course useful! :D

Thanks @Geir Arne Hjelle for your reply here. Great tips and I completely agree. For me, I’ve been mostly copy-pasting code from .py files into a Jupyter Notebook, if going into that direction.

Going the other way (.ipynb –> .py) is possible with a straightforward export from the Notebook interface, and that’s been the more common task for me. I’d use a Notebook for interactively developing a code snippet, but then want to convert it into a standalone .py script for running it without the overhead of the Notebook environment. Hope that helps!

I just started my Jupyter learning journey. I’m really enjoying what I’m learning. Thank you for a very informative training session.

FOr anyone working with the Macbook pro M1. I had a lot of trouble getting the extneisons installed. Ihad to move brew, python, and anconda to another path. Took a few hours but finally got it working. I alos essentially reset my computer. ENsure hte Javascript and CSS packages are downloaded from the github repo.

I followed the lesson but am having problems installing the nbextensions. When I clickon the nbextensions menu option I get a list of extensions unfortunately all have a no-entry or stop sign icon. I am using macos Sonoma 14.1.1 on Apple M1

@jjbwoollyback and @magnoliacodes I think that the team made some updates to the extensions manager since recording time.

You can access it from the main menu. Make sure that Settings → Enable Extension Manager is checked, and then you can navigate to it through View → Extension Manager.

In that view, you can search for extensions and install them, and view the extensions you already have installed.

Can you give it a try whether that works for you?

(venv) markrubin@Marks-MacBook-Pro realpython-course % jupyter nbextensions_configurator enable --user            
Traceback (most recent call last):
  File "/Users/markrubin/Development/realpython-course/venv/bin/jupyter-nbextensions_configurator", line 5, in <module>
    from jupyter_nbextensions_configurator.application import main
  File "/Users/markrubin/Development/realpython-course/venv/lib/python3.9/site-packages/jupyter_nbextensions_configurator/__init__.py", line 18, in <module>
    from notebook.base.handlers import APIHandler, IPythonHandler
ModuleNotFoundError: No module named 'notebook.base'

This is the error I am getting in my terminal once I get to this command.

However, in my extension manager, this is what I see.

Extension manager screengrab

Is this sufficient?

@markprubin yeah I think I bumped into the same error when I tried this the other day. Your screengrab looks good, it seems like you properly installed the extensions using the Extension Manager. 🙌

Can you work with them?

Hello,

Do you have to install packages such as jupyter_contrib_nbextensions from inside your Notebook server? Or will it also work if you install them off the server, i.e. on your computer’s terminal (in the correct cwd and with the virtual environment activated)? I’m just wondering why there is a difference between the two, and what the difference is… Thanks in advance.

@arthur55 as long as you make sure you’re installing them into the same environment that you’re running Jupyter in, then I think this should work fine.

The Notebook you view in your browser is just a graphical user interface that makes it more straightforward to interact with (including installing extensions).

Thanks for your response Martin. Apologies if I’m wrong but I don’t think this has been resolved already, although someone else encountered the same error message. I keep getting errors when trying to activate the configurator. This time I’ve tried to activate it from my terminal (Powershell), not on a J.N. server, using the command from the tutorial. The last line of the error message is

ModuleNotFoundError: No module named ‘notebook.base’

Do you know how I can resolve this? Many thanks.

@arthur55 yeah I think there’s been a change in how this extension manager works. I took a look and posted about it a bit further up and I think it might be best to just use the built-in extension manager at this point.

Hi, I was able to install the jupyter extension, but when I try to enable them, it doesn’t work and I can not get the extension tab in the interface. Any idea?

Thanks

Hi @Ignacio Romero how did you install the extensions? Did you approach it like described in the comment further up?