Metadata-Version: 2.1
Name: notebook_parameterizer
Version: 0.0.4
Summary: A tool to generate parameterized Jupyter Notebooks
Home-page: https://github.com/rasmunk/notebook_parameterizer
Author: Rasmus Munk
Author-email: rasmus.munk@nbi.ku.dk
License: MIT
Project-URL: Source Code, https://github.com/rasmunk/notebook_parameterizer
Description: ======================
        notebook_parameterizer
        ======================
        
        .. image:: https://travis-ci.org/rasmunk/notebook_parameterizer.svg?branch=master
            :target: https://travis-ci.org/rasmunk/notebook_parameterizer
        .. image:: https://badge.fury.io/py/notebook-parameterizer.svg
            :target: https://badge.fury.io/py/notebook-parameterizer
        
        A tool to generate parameterized Jupyter Notebooks. This tool is similar to that of Papermill, but acts as a compliment
        to parameterize a Notebook not based on a preset cell that contains the parameters, but allows for parameterization
        throughout a Notebook without having to specify so.
        
        Instead the `notebook_parameterizer` uses a parameters YAML file to define which variables should be set to what value.
        With these preset variables in the parameters file, the ``notebook_parameterizer`` searches every cell for variable assignments 
        that match the given key in the parameters file.
        
        -----
        Usage
        -----
        
        An example of how to use the `notebook_parameterizer` can be seen below::
        
            $ notebook_parameterizer -h
            Usage: notebook_parameterizer [OPTIONS] NOTEBOOK_PATH PARAMETERS_PATH
        
            Options:
            -o, --output_notebook_path TEXT
                                            Path to the parameterized output notebook
            -e, --expand_env_values         Should ENV_ prefixed parameter values be
                                            expanded to their matching OS environment
                                            variable value
        
            -h, --help                      Show this message and exit.
        
        
        The NOTEBOOK_PATH is the path to the Notebook that should be parameterized.
        
        The PARAMETERS_PATH is the path to the YAML file that contains the variables that should be parameterized.
        
        For instance, given the following Notebook in ``example/notebooks/hello_world.ipynb``.
        
        .. image:: res/hello_world.png
        
        
        We can paramterize the Notebook with the ``example/parameters/hello_world.yml`` parameters file::
        
            num: 1000
            div_by: 4
        
        
        This is achived by executing the following command::
        
            $ notebook_parameterizer example/notebooks/hello_world.ipynb \
             example/parameters/hello_world.yml \
             -o new_hello_world.ipynb
        
        
        After applying the ``notebook_parameterizer``, the generated ``new_hello_world.ipynb`` Notebook has the following content.
        
        .. image:: res/parameterized_hello_world.png
        
        
Keywords: jupyter notebook parameters
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: test
Provides-Extra: dev
