nbpages 0.0.1.dev3

Tools to maintain a respository of Jupyter notebooks

nbpages

nbpages provides a Python toolset for managing a github repository of Jupyter notebooks. The project was inspired by the tools included with the Python Data Science Handbook by Jake Vanderplas.

Installation

pip install nbpages

Usage

This package assumes you have already created a github repository containing one or more Jupyter notebooks in a subdirectory named notebooks. The notebook files end with a .ipynb suffix, and begin with a nn.mm- prefix. nn refers to the chapter number or, if a letter, to an Appendix. mm refers to section number. Section 00 includes the chapter title and any prefatory material.

To use, execute the command line

python nbpages

from the top level directory of the notebook repository. The initial use of this command will:

1. Create a directory named templates with configuration data found in the .git subdirectory, and jinja templates for a README.md file and notebook headers. The templates may be edited and include any variable from the configuration file.
2. Create README.md using the template README.md.jinja. The default template includes a formatted list of all notebooks in the respository.
3. Add headers and navigation bars in all notebooks. The headers can be modified by the editing notebook_header.jinja template.
4. Create a table of contents and a keyword index accessible from README.md and the navigation bars.

Table of Contents

Keyword Index

Chapter 1.0 Getting Started with nbcollection

• 1.1 Notebook Repository Layout

• 1.2 Configuration

Appendix A. Style Guide