Skip to main content

Jupyter Notebook Menu Extension.

Project description

Jupyter Notebook Menu Extensions


The idea of the Snippet Library is to create a tool for rapid prototyping with the aim of quickly and easily developing data analysis workflows. It adds a customizable menu to the Jupyter notebooks to insert code snippets, code examples and boilerplate code.

Snippets Showcase

This Jupyter extension is based on the Jupyter notebook snippets menu extension, which adds one ore more menu items after the Help menu in Jupyter notebooks. The menu provides small code snippets which are supposed to make your life easiser when playing around with data. How do I read a csv file? There´s a snippet for that. How do I visualize missing values in a pandas dataframe? There´s a snippet for that. How do I plot the correlation matrix of my pandas dataframe (and make it look good)?. There's a snippet for that. You get the idea.

Focus of the provided snippets is helping to get started (or to get more productive) on data science tasks. The menu provides several snippets ordered by typical task groups used for exploring and visualizing data.

The default menu provides the items:

  • Data which provides snippets to read, write and transform data
  • Modelling which provides snippets to train ML models (mostly based on sklearn). You'll find examples for classification, regression and clustering
  • Plotting which provides some regularly used snippets for matplotlib, bokeh and the pandas interface
  • Utils which provides some snippets which do not fit into the former categories but are still helpful

As described below, there's also the possibility to add your own snippets, either by copy-pasting them or by reading them from a .py file.

Configuration

The follwoing Prerequisites must be installed:

Anaconda

Python 3.X

Git

Installation

You can directly install the snippet library from pip using this command

pip install snippetlib

Install via Make (Linux)

git clone https://github.com/fraunhofer-iais/IAIS-Jupyter-Snippets-Extension.git

cd snippetlibrary

git checkout master

make install

After installation enter the following in the three lines in the command line (Anaconda Prompt for Windows):

jupyter nbextension install --py snippetlib --sys-prefix jupyter nbextension enable --py snippetlib --sys-prefix jupyter serverextension enable --py snippetlib --sys-prefix

Operating instructions

Start Jupyter Notebook

Windows: Open Anaconda prompt and type "jupyter notebook".

Linux: Open terminal and type "jupyter notebook“.

The Jupyter front-end should open in a browser window.

How to add your own snippets

To upload a new snippet on the jupyter notebook,paste the following in a new cell.

from snippetlib import upload_snippet as us

upload_snippets = us.Upload_Snippet()

Refresh the page and on the Snippets menu you should see the newly added snippet.

To create new snippets,on the jupyter notebook,paste the following in a new cell.

from snippetlib import paste_snippet as ps

paste_snippets = ps.Paste_Snippet()

Refresh the page and on the Snippets menu you should see the newly added snippet.

Add your own snippets

Credits and Acknolegements

The development of this Jupyter extension was supported by the Fraunhofer Lighhouse Project Machine Learning for Production (ML4P). The main development has been carried out by the Knowledge Discovery Department of the Fraunhofer IAIS.

Contact information

If you're interested in supporting the further development of this extension or if you need support for the usage please contact snippets@iais.fraunhofer.de.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

snippetlib-1.4-py3-none-any.whl (90.0 kB view details)

Uploaded Python 3

File details

Details for the file snippetlib-1.4-py3-none-any.whl.

File metadata

  • Download URL: snippetlib-1.4-py3-none-any.whl
  • Upload date:
  • Size: 90.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/40.5.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.6.10

File hashes

Hashes for snippetlib-1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8a5dc1074b248e84a6125786ce6e6a2f4b0e3b5e65ee13228bac399c2f80bb67
MD5 1e0dbdd8f42324f88ac9bd4751681622
BLAKE2b-256 2294d66576c93bfc277b1714d30f5280aca650a973c56483ef46b4a64eb20b8f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page