Metadata-Version: 1.1
Name: sftmpl
Version: 0.1
Summary: Single file templater
Home-page: http://github.com/pdebuyl/sftmpl
Author: Pierre de Buyl <pdebuyl at sign pdebuyl.be>
Author-email: pdebuyl at sign pdebuyl dot be
License: BSD
Description: =====================
        Single file templater
        =====================
        
        sftmpl takes a single file as input and uses the built-in string format method
        to replace the occurences of brace-enclosed variables by values given on the
        command-line.
        
        The aim of sftmpl is to simplify the generation of configuration file in
        computing protocols by providing a command-line enabled customization of these
        configuration files.
        
        Install
        -------
        
        Obtain the distribution file and use
        
            python setup.py install
        
        The source repository is https://github.com/pdebuyl/sftmpl.git and the code may
        be obtained via the command
        
            git clone https://github.com/pdebuyl/sftmpl.git
        
        Use
        ---
        
        sftmpl uses the curly brace named fields defined in `PEP 3101
        <https://www.python.org/dev/peps/pep-3101/>`_.
        
        For the following input file `myconfig.txt`, you must provide the command-line
        options `-N`, `--parameter` and `--N_steps`::
        
            # Config for "myprog"
            N = {N}
            parameter = {parameter}
            
            run {N_steps} steps
        
        The invocation is as follows when sftmpl is installed
        
            sftmpl myconfig.txt -N 10 --parameter 0.1 --N_steps 500
        
        and the following result is output to the standard output::
        
            # Config for "myprog"
            N = 10
            parameter = 0.1
        
            run 500 steps
        
        Misc
        ----
        
        Author: Pierre de Buyl
        
        License: Modified BSD (see `LICENSE`).
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Utilities
