1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
Welcome to papermill
====================
.. image:: https://github.com/nteract/papermill/actions/workflows/ci.yml/badge.svg
:target: https://github.com/nteract/papermill/actions/workflows/ci.yml
.. image:: https://codecov.io/github/nteract/papermill/coverage.svg?branch=main
:target: https://codecov.io/github/nteract/papermill?branch=main
.. image:: https://readthedocs.org/projects/papermill/badge/?version=latest
:target: http://papermill.readthedocs.io/en/latest/?badge=latest
.. image:: https://tinyurl.com/ybwovtw2
:target: https://mybinder.org/v2/gh/nteract/papermill/main?filepath=binder%2Fprocess_highlight_dates.ipynb
.. image:: https://tinyurl.com/y7uz2eh9
:target: https://mybinder.org/v2/gh/nteract/papermill/main?filepath=binder%2Fcli-simple%2Fcli_example.ipynb
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/ambv/black
**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.8+ versions. As minor python
versions are officially sunset by the python org papermill will similarly
drop support in the future.
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
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|
