Skip to content

lawrennd/notutils

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

60 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

notutils

Jupyter Notebook Utilities for Python

Tests Lint Documentation codecov


Overview

notutils is a collection of convenience functions designed to enhance the Jupyter Notebook experience for Python users. It provides convenient tools for displaying URLs, embedding iframes, visualizing Google Books, toggling code visibility, creating interactive prediction widgets, and more. The library was designed for teaching, presentations, and interactive data exploration.

Features

  • Display clickable URLs in notebooks
  • Embed external content with iframes
  • Visualize Google Books inline
  • Toggle code cell visibility for cleaner presentations
  • Interactive basis function prediction widgets
  • Display image and plot series with sliders
  • Utilities for Jupyter/IPython integration

Installation

You can install notutils using Poetry or pip:

Using Poetry

poetry add notutils

Using pip

pip install notutils

Note: notutils requires Python 3.9 or later. It depends on IPython, ipywidgets, matplotlib, and numpy.

Quick Start

from notutils import display_url, iframe_url, display_iframe_url

display_url("https://github.com/lawrennd/notutils")
iframe_html = iframe_url("https://www.example.com", width=800, height=400)
display_iframe_url("https://www.example.com", width=800, height=400)

Usage Examples

Display a Clickable URL

from notutils import display_url
display_url("https://www.python.org")

Embed an IFrame

from notutils import display_iframe_url
display_iframe_url("https://www.wikipedia.org", width=700, height=500)

Toggle Code Visibility

from notutils import code_toggle
code_toggle(start_show=False, message="Show/Hide code")

Interactive Prediction Widget

from notutils import display_prediction
# Define your basis function and call display_prediction(...)

Dependencies

  • Python >= 3.9
  • IPython
  • ipywidgets
  • matplotlib
  • numpy

Development & Contributing

  1. Clone the repository:
    git clone https://github.com/lawrennd/notutils.git
    cd notutils
  2. Install dependencies:
    poetry install
  3. Run tests:
    poetry run pytest
  4. See the backlog and CIPs for project planning and improvement proposals.

Contributions are welcome! Please open issues or pull requests for bugs, features, or documentation improvements.

License

This project is licensed under the BSD 3-clause license. See LICENSE.txt for details.

Links

About

Jupyter notebook utilities for python.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages