Metadata-Version: 2.1
Name: endomill
Version: 0.1.3
Summary: endomill lets a Jupyter notebook instantiate itself as a papermill template
Home-page: https://github.com/mmore500/endomill
Author: Matthew Andres Moreno
Author-email: m.more500@gmail.com
License: MIT license
Description: ========
        endomill
        ========
        
        
        .. image:: https://img.shields.io/pypi/v/endomill.svg
                :target: https://pypi.python.org/pypi/endomill
        
        .. image:: https://img.shields.io/travis/mmore500/endomill.svg
                :target: https://travis-ci.com/mmore500/endomill
        
        .. image:: https://readthedocs.org/projects/endomill/badge/?version=latest
                :target: https://endomill.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        
        
        
        endomill lets a Jupyter notebook instantiate itself as a papermill template.
        
        Plays nice across both interactive and automatic (i.e., nbconvert, nbclient) contexts.
        
        
        * Free software: MIT license
        * Documentation: https://endomill.readthedocs.io.
        
        
        Here's what cells from a notebook using endomill might look like.
        
        .. code-block:: python3
        
          import endomill
        
        
        Instantiate & execute this two copies of this notebook.
        
        .. code-block:: python3
        
          endomill.instantiate_over(
              parameter_packs=[
                  {'parameter' : 'value1'},
                  {'parameter' : 'value2'},
              ],
          )
        
        
        Supply papermill parameters.
        (Remember to add notebook cell "parameters" tag for papermill.)
        
        .. code-block:: python3
        
          # register papermill parameters
          parameter: str
        
        
        Override automatic endomill instance output path, if desired.
        
        .. code-block:: python3
        
          endomill.add_instance_outpath('custom_outpath.endomill.ipynb')
        
        
        Then do your Jupyter business as usual!
        
        .. code-block:: python3
        
          print('hello', parameter)
        
        
        Credits
        -------
        
        This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        
        =======
        History
        =======
        
        0.0.0 (2022-02-22)
        ------------------
        
        * First release on PyPI.
        
Keywords: endomill
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
