Skip to content

pauladanielafarias/jupyter_contrib_nbextensions

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 

Repository files navigation

Installing jupyter_contrib_nbextensions

How to install the jupyter_contrib_nbextensions and which are the extensions provided.

I. Installing Conda

Before installing anything that's below, you must install Conda. If you already have it installed, skip this step.

You can do it from here: https://docs.conda.io/en/latest/miniconda.html#

If you have Windows 10, remember that after installing Conda, you'll need to set the path to the location where you installed it. To do that you need to:

  1. Hit the Windows key
  2. Search the word 'environment'
  3. Choose 'Edit environment variables for your account'
  4. Select the Path variable (double click)
  5. Click 'New'.
  6. Paste the path where you have the Miniconda installed e.g. C:\ProgramData\Miniconda3 and also the scripts folder path e.g. C:\ProgramData\Miniconda3\Scripts

To test it, open a new cmd shell, and you should be able to use conda commands now, e.g. try conda --version.

II. Installing Jupyter Notebook using Conda

Before you can install the extensions, you must install Jupyter Notebook. If you already have it installed, skip this step.

NOTICE: It doesn't work with the JupyterLab version.

conda install -c conda-forge notebook

If you have Windows 10 and the command gives you this error HTTP 000 CONNECTION FAILED for url <https://conda.anaconda.org/conda-forge/win-64/current_repodata.json>

You should do the following:

  1. Install OpenSSL
  2. Start your command prompt with run as administrator
  3. Try to run the command above to install Jupyter Notebook again

III. Installing jupyter_contrib_nbextensions using Conda

  1. There are conda packages for the notebook extensions and the jupyter_nbextensions_configurator available from conda-forge. You can install both using:
conda install -c conda-forge jupyter_contrib_nbextensions
  1. The jupyter_nbextensions_configurator jupyter server extension provides graphical user interfaces for configuring which nbextensions are enabled (load automatically for every notebook). In addition, for nbextensions which include an appropriate yaml descriptor file (see below), the interface also renders their markdown readme files, and provides controls to configure the nbextensions' options.
conda install -c conda-forge jupyter_nbextensions_configurator
  1. Once jupyter_nbextensions_configurator is installed and enabled, and your notebook server has been restarted, you should be able to find the nbextensions configuration interface at the url http://localhost:8889/tree (or whatever port you have) in the Nbextensions tab.

Reminder: to start your notebook server just go to the terminal, cd path/to/directory and run the command jupyter-notebook, this will open a new tab in Google Chrome with your Jupyter Notebook and your files in it.

  1. Copy the nbextensions’ javascript and css files into your jupyter server’s search directory. This will 'install' all the nbextensions and you'll be able to see them in the Nbextensions tab. There you can enable or disable the ones you want.
jupyter contrib nbextension install --user

nbextensions configuration interface

The information above is an abstract from the information available at:


Extensions provided

Some of the extensions to make the notebook more user friendly:

  • Hinterland: This extension enables code autocompletion menu for every keypress in a code cell, instead of only enabling it with tab.

  • Code prettify: This extension uses kernel-specific code to reformat/prettify the contents of code cells.

  • Code folding: This extension enables the CodeMirror feature to allow codefolding in code cells.

  • ExecuteTime: This extension displays when each cell has been executed and how long it took.

  • Snippets Menu: This extension adds a customizable menu item to insert code and markdown snippets. Comes with extensive defaults for popular python modules, including fairly complete listings of many important functions and constants, to save searching through documentation.

  • Scratchpad notebook: This extension adds a scratchpad cell to Jupyter notebook. This is a cell in which you can execute code against the current kernel without modifying the notebook document.

  • ScrollDown: This extension scrolls cells' outputs down automatically as they are enlarged. (It can be enabled and disabled using the toolbar button).

  • Variable Inspector: This extension collects all defined variables and display them in a floating window. The extension is also draggable, resizable, collapsable.

  • Hide input: This extension toggles display of selected code cell's input

  • Spellchecker: This extension adds a CodeMirror overlay mode for Typo.js spellchecking. (Default language is en_US)

  • Highlighter: This extension provides several toolbar buttons for highlighting a selected text within a markdown cell.

Here's the list of all the available extensions that can be enabled: List of provided nbextensions

List of jupyter_contrib_nbextensions

About

How to install the jupyter_contrib_nbextensions

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published