Skip to content

Latest commit

 

History

History
83 lines (61 loc) · 2.6 KB

File metadata and controls

83 lines (61 loc) · 2.6 KB

Welcome to papermill

https://codecov.io/github/nteract/papermill/coverage.svg?branch=main https://readthedocs.org/projects/papermill/badge/?version=latest https://tinyurl.com/ybwovtw2 https://tinyurl.com/y7uz2eh9

Papermill is a tool for parameterizing and executing Jupyter Notebooks.

Papermill lets you:

  • parameterize notebooks
  • execute notebooks

This opens up new opportunities for how notebooks can be used. For example:

  • Perhaps you have a financial report that you wish to run with different values on the first or last day of a month or at the beginning or end of the year, using parameters makes this task easier.
  • Do you want to run a notebook and depending on its results, choose a particular notebook to run next? You can now programmatically execute a workflow without having to copy and paste from notebook to notebook manually.

Python Version Support

This library currently supports python 3.10+ versions. As minor python versions are officially sunset by the python org papermill will similarly drop support in the future.

Citing Papermill

If Papermill supports your research, please cite it as software in your publication and include the version that you used. For example:

nteract contributors. Papermill: parameterize and execute Jupyter notebooks.
Version X.Y.Z. https://github.com/nteract/papermill

Documentation

These pages guide you through the installation and usage of papermill.

.. toctree::
   :maxdepth: 2

   installation
   usage-workflow
   usage-cli
   extending-overview
   troubleshooting
   changelog

API Reference

If you are looking for information about a specific function, class, or method, this documentation section will help you.

.. toctree::
   :maxdepth: 3

   reference/index.rst

Indices and tables