cascandaliato/papermill repository overview

⁠Papermill⁠ Docker CLI ·

Papermill⁠ is a tool for parameterizing and executing Jupyter Notebooks. This is a dockerized version meant to be called from the command line. It includes all pre-requisites, except for Docker⁠ itself.

⁠Usage Instructions

1. Install Docker⁠.
2. Open a command prompt or shell, move to the folder containing your notebooks.
3. Run:
   • (Windows) docker run --mount type=bind,source=%CD%,destination=/notebooks cascandaliato/papermill <options>
   • (Linux) docker run --mount type=bind,source=$(pwd),destination=/notebooks cascandaliato/papermill <options>

For example, docker run --mount type=bind,source=$(pwd),destination=/notebooks cascandaliato/papermill input.ipynb output.ipynb will execute notebook input.ipynb and save the updated notebook to output.ipynb.

For the list of supported commands, read the official usage instructions⁠ or run:

• (Windows) docker run --mount type=bind,source=%CD%,destination=/notebooks cascandaliato/papermill
• (linux) docker run --mount type=bind,source=$(pwd),destination=/notebooks cascandaliato/papermill

⁠Custom Package Requirements

If your notebook requires additional packages, you can specify them within text files to be placed in same folder as your notebooks:

• (Ubuntu packages) apt-requirements.txt
• (Python3 packages) requirements.txt

These files should contain one package per line.