Skip to main content

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.

Source Distribution

nbfancy-0.1.dev2.tar.gz (148.2 kB view details)

Uploaded Source

Built Distribution

nbfancy-0.1.dev2-py3-none-any.whl (166.7 kB view details)

Uploaded Python 3

File details

Details for the file nbfancy-0.1.dev2.tar.gz.

File metadata

  • Download URL: nbfancy-0.1.dev2.tar.gz
  • Upload date:
  • Size: 148.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for nbfancy-0.1.dev2.tar.gz
Algorithm Hash digest
SHA256 7a73b65a16c11dd363a88bf92cf23744471fa5227c560c78a64f352355d255d7
MD5 69ac0d6dd483eb6965c4506b35553b25
BLAKE2b-256 702bce53ef3aedee370a475488663821bc4230057f1de84f62e170d2329fd3c1

See more details on using hashes here.

File details

Details for the file nbfancy-0.1.dev2-py3-none-any.whl.

File metadata

  • Download URL: nbfancy-0.1.dev2-py3-none-any.whl
  • Upload date:
  • Size: 166.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for nbfancy-0.1.dev2-py3-none-any.whl
Algorithm Hash digest
SHA256 329bb41eeda99314a467eccc9461da22107fd3b5f9ac91fd34ff161c4a4d03c8
MD5 c06b49587ee2fb4256722bb7f0be4fa5
BLAKE2b-256 5cb531fa55958bf84edeff16f40bea68d0ac048ac2eb480783c293343faa7854

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