Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

Tools for rendering notebooks suitable for teaching

Project description

NBfancy

(C) 2019 Jack Betteridge (j.d.betteridge@bath.ac.uk) and James Grant (r.j.grant@bath.ac.uk)

This repository contains NBfancy, a tool for adding decoration and extended features to Jupyter notebooks. The code was developed by Jack Betteridge and James Grant for the development of programming training material.

Documentation

The install contains the tools which make up the build system for enriching notebooks, and by way of example, also contains the documentation in the form of a tutorial. This material will assist users in creating their own courses, as both a lesson and demonstration of NBfancy's capabilities.

Jupyter notebooks were chosen as the medium for out training material as:

  • They use markdown which is simple to use even for those not familiar.
  • Modifying individual codeblocks is intuitive compared with Sphinx/Jekyll builds.
  • We like being able to mix markdown and executable codeblocks in training material.

In order to retain these features we created NBfancy to process initial notebooks into enriched Jupyter notebooks for interactive use by students, html pages for lesson material and pdfs for distribution as printouts (coming n a future release).

The documentation/tutorial is available online in rendered html

Contributions to NBfancy

If you would like to contribute to NBfancy please fork the repository and create a pull request against the development branch.

Project details


Download files

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

Files for nbfancy, version 0.1.dev2
Filename, size File type Python version Upload date Hashes
Filename, size nbfancy-0.1.dev2-py3-none-any.whl (166.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size nbfancy-0.1.dev2.tar.gz (148.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page