Tools to maintain a respository of Jupyter notebooks
Project description
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
Initial Setup
This package assumes you have created a github repository containing one or more Jupyter notebooks (*.ipynb) in a
subdirectory named notebooks
. The initial setup is performed with the command
python nbpages --setup
This creates a directory named templates
if needed with configuration data found in the .git
subdirectory. If not
already present, Jinja templates README.md.jinja
and notebook_header.jinja
are created. These templates should be
edited as required.
Normal Usage
Notebooks filenames are prefixed with nn.mm-
wherenn
refers to the chapter number or, if a letter, to an Appendix.
mmrefers to the section number. Section
00` 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 command will add or amend headers and navigation bars in all notebooks, and create a table of contents and a keyword index accessible from README.md and the navigation bars.
Utilities
To help achieve a consistent style over a collection of notebooks, use the command
python nbpages --lint
to locate some forms of notebook 'lint'. A current list of additional features can be found
python nbpages --help
Table of Contents
Keyword Index
Chapter 1.0 Getting Started with nbcollection
Appendix A. Style Guide
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.