{ "info": { "author": "Yash", "author_email": "yashanantha@outlook.com", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "Intended Audience :: Science/Research", "Intended Audience :: System Administrators", "License :: OSI Approved :: BSD License", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3" ], "description": "\n=======================================================================================================================================================================\n\n\n[![Travis Build Status](https://travis-ci.org/nteract/papermill.svg?branch=master)](https://travis-ci.org/nteract/papermill)\n[![Azure Build Status](https://dev.azure.com/nteract/nteract/_apis/build/status/nteract.papermill?branchName=master)](https://dev.azure.com/nteract/nteract/_build/latest?definitionId=5&branchName=master)\n[![image](https://codecov.io/github/nteract/papermill/coverage.svg?branch=master)](https://codecov.io/github/nteract/papermill?branch=master)\n[![Documentation Status](https://readthedocs.org/projects/papermill/badge/?version=latest)](http://papermill.readthedocs.io/en/latest/?badge=latest)\n[![badge](https://tinyurl.com/ybwovtw2)](https://mybinder.org/v2/gh/nteract/papermill/master?filepath=binder%2Fprocess_highlight_dates.ipynb)\n[![badge](https://tinyurl.com/y7uz2eh9)](https://mybinder.org/v2/gh/nteract/papermill/master?filepath=binder%2Fcli-simple%2Fcli_example.ipynb)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n\n**papermill for CI/CD** is a tool for parameterizing, executing, and analyzing\nJupyter Notebooks.\n\nPapermill lets you:\n\n- **parameterize** notebooks\n- **execute** notebooks\n\nThis opens up new opportunities for how notebooks can be used. For\nexample:\n\n- Perhaps you have a financial report that you wish to run with\n different values on the first or last day of a month or at the\n beginning or end of the year, **using parameters** makes this task\n easier.\n- Do you want to run a notebook and depending on its results, choose a\n particular notebook to run next? You can now programmatically\n **execute a workflow** without having to copy and paste from\n notebook to notebook manually.\n\n## Modifications to original library\n- This is forked from [papermill](https://github.com/nteract/papermill)\n- This works with [run-notebook](https://github.com/marketplace/actions/run-notebook) github action\n- The output from notebook goes to a `stdout` and to a file called `papermill-nb-runner.out` if `log_output` option is set\n- Skips executing any cells that has `debug` tag in them\n\n## Installation\n\nFrom the command line:\n\n``` {.sourceCode .bash}\npip install papermill\n```\n\nFor all optional io dependencies, you can specify individual bundles\nlike `s3`, or `azure` -- or use `all`\n\n``` {.sourceCode .bash}\npip install papermill[all]\n```\n\n## Python Version Support\n\nThis library will support python 2.7 and 3.5+ until end-of-life for python 2 in 2020. After which python 2 support will halt and only 3.x version will be maintained.\n\n## Usage\n\n### Parameterizing a Notebook\n\nTo parameterize your notebook designate a cell with the tag ``parameters``.\n\n![enable parameters in Jupyter](docs/img/enable_parameters.gif)\n\nPapermill looks for the ``parameters`` cell and treats this cell as defaults for the parameters passed in at execution time. Papermill will add a new cell tagged with ``injected-parameters`` with input parameters in order to overwrite the values in ``parameters``. If no cell is tagged with ``parameters`` the injected cell will be inserted at the top of the notebook.\n\nAdditionally, if you rerun notebooks through papermill and it will reuse the ``injected-parameters`` cell from the prior run. In this case Papermill will replace the old ``injected-parameters`` cell with the new run's inputs.\n\n![image](docs/img/parameters.png)\n\n### Executing a Notebook\n\nThe two ways to execute the notebook with parameters are: (1) through\nthe Python API and (2) through the command line interface.\n\n#### Execute via the Python API\n\n``` {.sourceCode .python}\nimport papermill as pm\n\npm.execute_notebook(\n 'path/to/input.ipynb',\n 'path/to/output.ipynb',\n parameters = dict(alpha=0.6, ratio=0.1)\n)\n```\n\n#### Execute via CLI\n\nHere's an example of a local notebook being executed and output to an\nAmazon S3 account:\n\n``` {.sourceCode .bash}\n$ papermill local/input.ipynb s3://bkt/output.ipynb -p alpha 0.6 -p l1_ratio 0.1\n```\n\n**NOTE:**\nIf you use multiple AWS accounts, and you have [properly configured your AWS credentials](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html), then you can specify which account to use by setting the `AWS_PROFILE` environment variable at the command-line. For example:\n\n``` {.sourceCode .bash}\n$ AWS_PROFILE=dev_account papermill local/input.ipynb s3://bkt/output.ipynb -p alpha 0.6 -p l1_ratio 0.1\n```\n\nIn the above example, two parameters are set: ``alpha`` and ``l1_ratio`` using ``-p`` (``--parameters`` also works). Parameter values that look like booleans or numbers will be interpreted as such. Here are the different ways users may set parameters:\n\n``` {.sourceCode .bash}\n$ papermill local/input.ipynb s3://bkt/output.ipynb -r version 1.0\n```\n\nUsing ``-r`` or ``--parameters_raw``, users can set parameters one by one. However, unlike ``-p``, the parameter will remain a string, even if it may be interpreted as a number or boolean.\n\n``` {.sourceCode .bash}\n$ papermill local/input.ipynb s3://bkt/output.ipynb -f parameters.yaml\n```\n\nUsing ``-f`` or ``--parameters_file``, users can provide a YAML file from which parameter values should be read.\n\n``` {.sourceCode .bash}\n$ papermill local/input.ipynb s3://bkt/output.ipynb -y \"\nalpha: 0.6\nl1_ratio: 0.1\"\n```\n\nUsing ``-y`` or ``--parameters_yaml``, users can directly provide a YAML string containing parameter values.\n\n``` {.sourceCode .bash}\n$ papermill local/input.ipynb s3://bkt/output.ipynb -b YWxwaGE6IDAuNgpsMV9yYXRpbzogMC4xCg==\n```\n\nUsing ``-b`` or ``--parameters_base64``, users can provide a YAML string, base64-encoded, containing parameter values.\n\nWhen using YAML to pass arguments, through ``-y``, ``-b`` or ``-f``, parameter values can be arrays or dictionaries:\n\n``` {.sourceCode .bash}\n$ papermill local/input.ipynb s3://bkt/output.ipynb -y \"\nx:\n - 0.0\n - 1.0\n - 2.0\n - 3.0\nlinear_function:\n slope: 3.0\n intercept: 1.0\"\n```\n\n#### Supported Name Handlers\n\nPapermill supports the following name handlers for input and output paths during execution:\n\n * Local file system: `local`\n\n * HTTP, HTTPS protocol: `http://, https://`\n\n * Amazon Web Services: [AWS S3](https://aws.amazon.com/s3/) `s3://`\n\n * Azure: [Azure DataLake Store](https://docs.microsoft.com/en-us/azure/data-lake-store/data-lake-store-overview), [Azure Blob Store](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-overview) `adl://, abs://`\n\n * Google Cloud: [Google Cloud Storage](https://cloud.google.com/storage/) `gs://`\n\nDevelopment Guide\n-----------------\n\nRead [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to setup a local development environment and make code changes back to Papermill.\n\nFor development guidelines look in the [DEVELOPMENT_GUIDE.md](./DEVELOPMENT_GUIDE.md) file. This should inform you on how to make particular additions to the code base.\n\nDocumentation\n-------------\n\nWe host the [Papermill documentation](http://papermill.readthedocs.io)\non ReadTheDocs.", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/nteract/papermill", "keywords": "jupyter mapreduce nteract pipeline notebook", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "papermill-nb-runner", "package_url": "https://pypi.org/project/papermill-nb-runner/", "platform": "", "project_url": "https://pypi.org/project/papermill-nb-runner/", "project_urls": { "Documentation": "https://papermill.readthedocs.io", "Funding": "https://nteract.io", "Homepage": "https://github.com/nteract/papermill", "Source": "https://github.com/nteract/papermill/", "Tracker": "https://github.com/nteract/papermill/issues" }, "release_url": "https://pypi.org/project/papermill-nb-runner/1.1.16/", "requires_dist": null, "requires_python": "", "summary": "Use papermill in CI/CD.", "version": "1.1.16" }, "last_serial": 5732962, "releases": { "1.1.0": [ { "comment_text": "", "digests": { "md5": "a1888fb777607add19de4760403ff21d", "sha256": "fbbf01edfe2105a6d8e1c1ff7656f2b1cb90771699df4fbcc6cf6de68ddc9e53" }, "downloads": -1, "filename": "papermill-nb-runner-1.1.0.tar.gz", "has_sig": false, "md5_digest": "a1888fb777607add19de4760403ff21d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 934974, "upload_time": "2019-08-23T16:39:10", "url": "https://files.pythonhosted.org/packages/41/fd/da7ddadd68226e658130f8e3597e0ab0ad29292771c593fb1b1c3bbd2bbd/papermill-nb-runner-1.1.0.tar.gz" } ], "1.1.1": [ { "comment_text": "", "digests": { "md5": "cd4b87b9fa49a3000b24fe977203a560", "sha256": "d4ce091aaafcb139391789cc070b75fc9c6d1adf4a59e5a77a267ab88ecad17f" }, "downloads": -1, "filename": "papermill-nb-runner-1.1.1.tar.gz", "has_sig": false, "md5_digest": "cd4b87b9fa49a3000b24fe977203a560", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 935008, "upload_time": "2019-08-23T16:45:06", "url": "https://files.pythonhosted.org/packages/fd/e5/ad838025991ea7b99de60d7bd0dfce3d1a92d73d1e7e867a1881b59373ba/papermill-nb-runner-1.1.1.tar.gz" } ], "1.1.10": [ { "comment_text": "", "digests": { "md5": "6a71844974605a10ce47bb963d3c5b38", "sha256": "219510ce93d2be05827e65eb28c444ed3fda9ecbd59a7c7c39de46c5a45ee2cb" }, "downloads": -1, "filename": "papermill-nb-runner-1.1.10.tar.gz", "has_sig": false, "md5_digest": "6a71844974605a10ce47bb963d3c5b38", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 935444, "upload_time": "2019-08-26T17:17:06", "url": "https://files.pythonhosted.org/packages/1e/ce/8066fc323b9713a89149dc9f4bbd16dfbd87fc68076db19c77170a0c2042/papermill-nb-runner-1.1.10.tar.gz" } ], "1.1.11": [ { "comment_text": "", "digests": { "md5": "f717282ce81f2357fe829468e1031829", "sha256": "7e841fd224379315fd0f0878da05d3b8ffa02b3dfd2a2b4933364f6b5cc26790" }, "downloads": -1, "filename": "papermill-nb-runner-1.1.11.tar.gz", "has_sig": false, "md5_digest": "f717282ce81f2357fe829468e1031829", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 935451, "upload_time": "2019-08-26T18:32:19", "url": "https://files.pythonhosted.org/packages/a3/75/e0046a7095876eef2917553ad2de1f8c618ddc0b152ca5967002678140ad/papermill-nb-runner-1.1.11.tar.gz" } ], "1.1.12": [ { "comment_text": "", "digests": { "md5": "588332a079316b51d7e89d3668ca13c2", "sha256": "efd3d124028556a6c54be5f02ca42582f43c7407a2ac7051db3f16f81e272a04" }, "downloads": -1, "filename": "papermill-nb-runner-1.1.12.tar.gz", "has_sig": false, "md5_digest": "588332a079316b51d7e89d3668ca13c2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 935441, "upload_time": "2019-08-26T19:02:32", "url": "https://files.pythonhosted.org/packages/a8/6f/495b00e77edb298cbd3efdc7ed711a37be2bdd2339bed30b163b9888122c/papermill-nb-runner-1.1.12.tar.gz" } ], "1.1.13": [ { "comment_text": "", "digests": { "md5": "e3a37706d2b8a69e0999407409e0f6a8", "sha256": "7588ae6d33a88a58ccd82e74874a89b32053cbe7e44071b1f7d05365015932dc" }, "downloads": -1, "filename": "papermill-nb-runner-1.1.13.tar.gz", "has_sig": false, "md5_digest": "e3a37706d2b8a69e0999407409e0f6a8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 935442, "upload_time": "2019-08-26T19:29:44", "url": "https://files.pythonhosted.org/packages/ee/d5/5f8bd1260d23756bbb4b3eb2eeade0cd1a14499a3215cd2238035624c50b/papermill-nb-runner-1.1.13.tar.gz" } ], "1.1.14": [ { "comment_text": "", "digests": { "md5": "79a420a2050e7a2970e7823e3135461f", "sha256": "f860e1b50caad4afebc013257faf2d8b0cfebc3d0d6602c8dc520727c166dea6" }, "downloads": -1, "filename": "papermill-nb-runner-1.1.14.tar.gz", "has_sig": false, "md5_digest": "79a420a2050e7a2970e7823e3135461f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 935414, "upload_time": "2019-08-26T19:42:56", "url": "https://files.pythonhosted.org/packages/e0/e6/143fab99c477766457ad4977d5d7c302de6c54873b029cace9dc8feb4dce/papermill-nb-runner-1.1.14.tar.gz" } ], "1.1.15": [ { "comment_text": "", "digests": { "md5": "6e6610b3eeff1266663e3732cc93f2ec", "sha256": "9755940c9c284a7f708c220a1d69fd68d743689d2c0a25a50e4d1485dcf3979e" }, "downloads": -1, "filename": "papermill-nb-runner-1.1.15.tar.gz", "has_sig": false, "md5_digest": "6e6610b3eeff1266663e3732cc93f2ec", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 935458, "upload_time": "2019-08-26T20:14:00", "url": "https://files.pythonhosted.org/packages/1d/35/8e1eef0509e1adb3d03b5250941f9f41613153e47d47eb9fc1e0ad566b24/papermill-nb-runner-1.1.15.tar.gz" } ], "1.1.16": [ { "comment_text": "", "digests": { "md5": "bf5b390d3ae512d1609fb33a83b9152e", "sha256": "df1698854f0d03e29f1b3e2ce38a08dfa4f25e3e78f96267e3a24c3da9ca94ae" }, "downloads": -1, "filename": "papermill-nb-runner-1.1.16.tar.gz", "has_sig": false, "md5_digest": "bf5b390d3ae512d1609fb33a83b9152e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 935456, "upload_time": "2019-08-26T20:24:15", "url": "https://files.pythonhosted.org/packages/3d/60/6a17f9dd3ee05e35f659a5455a712ac2313fe213ef22a60af8e649835edf/papermill-nb-runner-1.1.16.tar.gz" } ], "1.1.2": [ { "comment_text": "", "digests": { "md5": "56a61b9add3f285f11c14cb6a0deb930", "sha256": "f3dbe7f52a68a33daaeb28f00e9ba06c70cdbca4a044ddeaafe289f8074e3832" }, "downloads": -1, "filename": "papermill-nb-runner-1.1.2.tar.gz", "has_sig": false, "md5_digest": "56a61b9add3f285f11c14cb6a0deb930", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 935032, "upload_time": "2019-08-23T16:51:12", "url": "https://files.pythonhosted.org/packages/2a/4f/d70aaab908142b9b78810d585b98c7e02fe9303a01506fe9822f6c0b46ca/papermill-nb-runner-1.1.2.tar.gz" } ], "1.1.3": [ { "comment_text": "", "digests": { "md5": "932dfca50f7f844adeb740c9bf064f75", "sha256": "6b6a8a53e0acd3ddbd7c81e840b31b863251e4fbd6ff606a3446e38c857ccbfe" }, "downloads": -1, "filename": "papermill-nb-runner-1.1.3.tar.gz", "has_sig": false, "md5_digest": "932dfca50f7f844adeb740c9bf064f75", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 935011, "upload_time": "2019-08-23T16:54:57", "url": "https://files.pythonhosted.org/packages/3a/56/e2d1d0abe6261286a8a49a654ae246c0dc0e0e5ad212baf27e2d967f0645/papermill-nb-runner-1.1.3.tar.gz" } ], "1.1.4": [ { "comment_text": "", "digests": { "md5": "75cae3edecbe5a26946e0428fbb49c01", "sha256": "eeedc8c7882452a1cb135d232e09a86ef4fd7bf0b2585cae4e0bf299daa87722" }, "downloads": -1, "filename": "papermill-nb-runner-1.1.4.tar.gz", "has_sig": false, "md5_digest": "75cae3edecbe5a26946e0428fbb49c01", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 934972, "upload_time": "2019-08-23T16:58:47", "url": "https://files.pythonhosted.org/packages/4c/96/fdd9943d4589f6041cf140de3f0d9a89efe6eccc9cf0e0f062fd70af273c/papermill-nb-runner-1.1.4.tar.gz" } ], "1.1.5": [ { "comment_text": "", "digests": { "md5": "371cd8ff059cdb5a7ae307eff71f61ae", "sha256": "ea484a16f690ee484923d9d703fbdf6b93dfbb7b2ff68a50739a5e1b5a4cae76" }, "downloads": -1, "filename": "papermill-nb-runner-1.1.5.tar.gz", "has_sig": false, "md5_digest": "371cd8ff059cdb5a7ae307eff71f61ae", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 935026, "upload_time": "2019-08-23T19:37:31", "url": "https://files.pythonhosted.org/packages/43/8f/5458d7516bf176b1b2227f56178ddcd01920bbec93c4675ac54f1a365fba/papermill-nb-runner-1.1.5.tar.gz" } ], "1.1.6": [ { "comment_text": "", "digests": { "md5": "16c25877934dfc54ef5291872cdf6bb2", "sha256": "2886fb4fb562488896b03b0ae4f29f06f739d4fc04f7615c92c90da54f77ec50" }, "downloads": -1, "filename": "papermill-nb-runner-1.1.6.tar.gz", "has_sig": false, "md5_digest": "16c25877934dfc54ef5291872cdf6bb2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 935035, "upload_time": "2019-08-23T19:44:33", "url": "https://files.pythonhosted.org/packages/77/b9/1117be0eb4b669044d5dd7b4c5e18ac38aa7d26d301a326f0eee9cdf8afb/papermill-nb-runner-1.1.6.tar.gz" } ], "1.1.7": [ { "comment_text": "", "digests": { "md5": "4cb5fdb820c8b1ec4ec019a7f444321c", "sha256": "ea8782e59a7b9782548a3b1f3915a77df6bf0491287a503c76bf8a0916bfa7c0" }, "downloads": -1, "filename": "papermill-nb-runner-1.1.7.tar.gz", "has_sig": false, "md5_digest": "4cb5fdb820c8b1ec4ec019a7f444321c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 935083, "upload_time": "2019-08-23T20:16:04", "url": "https://files.pythonhosted.org/packages/52/9e/541f37669d4a81f24fd3ee2feaaf2d9ad8f15d5f677fdf8b7b3081be5a7b/papermill-nb-runner-1.1.7.tar.gz" } ], "1.1.8": [ { "comment_text": "", "digests": { "md5": "63f723fdb7c756fb142e0c6cde6d8937", "sha256": "89299114469ed1fe113f7badb79a0e17f0a3515d86fbae9fca9564acd397b3c6" }, "downloads": -1, "filename": "papermill-nb-runner-1.1.8.tar.gz", "has_sig": false, "md5_digest": "63f723fdb7c756fb142e0c6cde6d8937", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 935283, "upload_time": "2019-08-26T16:44:45", "url": "https://files.pythonhosted.org/packages/19/44/9c348539ee99cfc644f36b33a0cbea2e925af5eb1b0bf8388146473485d9/papermill-nb-runner-1.1.8.tar.gz" } ], "1.1.9": [ { "comment_text": "", "digests": { "md5": "c6a7d56174b1f076927394be744e4116", "sha256": "a7783669396b5cfca034c4259108e496f26b106baa0fa5ec9ba3cbbc70fa1ff5" }, "downloads": -1, "filename": "papermill-nb-runner-1.1.9.tar.gz", "has_sig": false, "md5_digest": "c6a7d56174b1f076927394be744e4116", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 935408, "upload_time": "2019-08-26T16:58:39", "url": "https://files.pythonhosted.org/packages/ac/48/3251f0f53b74ffc21adf1a2bfb889c8b88a1acd01adadfb180769b0654ee/papermill-nb-runner-1.1.9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "bf5b390d3ae512d1609fb33a83b9152e", "sha256": "df1698854f0d03e29f1b3e2ce38a08dfa4f25e3e78f96267e3a24c3da9ca94ae" }, "downloads": -1, "filename": "papermill-nb-runner-1.1.16.tar.gz", "has_sig": false, "md5_digest": "bf5b390d3ae512d1609fb33a83b9152e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 935456, "upload_time": "2019-08-26T20:24:15", "url": "https://files.pythonhosted.org/packages/3d/60/6a17f9dd3ee05e35f659a5455a712ac2313fe213ef22a60af8e649835edf/papermill-nb-runner-1.1.16.tar.gz" } ] }