whigg/jupylecture

Template for a lecture series using jupyter notebook slides

Creating lectures using jupyter notebook slides with RISE and reveal.js

You can run the first 'lecture' in an interactive jupyter notebook here

The RISE extension allows you to run reveal.js presentations with embedded code cells from jupyter. The jupylecture module adds functionality to the default RISE functionality, such as for example more freedom in placing content on the slides by using flexboxes.

Installation

Clone the jupylecture repository and install using pip (possibly in your dedicated virtual environment)

git clone https://github.com/strawpants/jupylecture 
pip install jupylecture

Initializing a new lecture setup

Navigate to a suitable destination direction and initialize the lecture files:

mkdir testlecture
cd testlecture
jupylectureinit.py NewLecture.ipynb

After initialization you can start a jupyter instance and navigate to the notebook

Tips and Tricks

• Enable fullscreen when developing the lecture in a browser, this ensures that the aspect ratio of your lecture will be correct.
• A bash script to export the notebooks is provided to convert the presentation to a pdf format
• You can edit the slide description shown in the footer by going to Edit-> Edit Notebook Metadata
• For developers: When an editable installation has been performed (pip install -e jupylecture) it's possible to add the --develop flag to jupylecture.py, so the css files and image files are symlinked instead of copied. This allows parallel development of lectures and this module (e.g. no need to update rise.css)

Todo

• Publish on pypi when this package is a bit more mature
• Enable a static export to html