Skip to main content

A tool to convert sets of Jupyter notebook files into a single, cohesive set of linked pages

Project description

nbpretty is a tool to convert sets of notebook files into a single, cohesive set of linked pages.

Usage

Create a file called config.yaml with the following contents:

---
course_title: Best practices in software engineering

The main pages will be created bases on their names. You should name your chapters like: 00 Introduction.ipynb, 01 First Chapter.ipynb etc.

and then run it with:

nbpretty .

It will write out HTML and CSS files which can then be uploaded/viewed/whatever.

For development, I recommend using entr with:

while sleep 1 ; do find . -name '*.ipynb' | entr -d nbpretty . ; done

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

nbpretty-0.1.1.tar.gz (7.7 kB view hashes)

Uploaded Source

Built Distribution

nbpretty-0.1.1-py3-none-any.whl (8.9 kB view hashes)

Uploaded Python 3

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