Metadata-Version: 1.1
Name: procrunner
Version: 0.6.0
Summary: Versatile utility function to run external processes
Home-page: https://github.com/DiamondLightSource/python-procrunner
Author: Markus Gerstel
Author-email: scientificsoftware@diamond.ac.uk
License: BSD license
Description: ==========
        ProcRunner
        ==========
        
        
        .. image:: https://img.shields.io/pypi/v/procrunner.svg
                :target: https://pypi.python.org/pypi/procrunner
        
        .. image:: https://travis-ci.org/DiamondLightSource/python-procrunner.svg?branch=master
                :target: https://travis-ci.org/DiamondLightSource/python-procrunner
        
        .. image:: https://ci.appveyor.com/api/projects/status/jtq4brwri5q18d0u/branch/master
                :target: https://ci.appveyor.com/project/Anthchirp/python-procrunner
        
        .. image:: https://readthedocs.org/projects/procrunner/badge/?version=latest
                :target: https://procrunner.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        .. image:: https://pyup.io/repos/github/DiamondLightSource/python-procrunner/shield.svg
             :target: https://pyup.io/repos/github/DiamondLightSource/python-procrunner/
             :alt: Updates
        
        
        Versatile utility function to run external processes
        
        
        * Free software: BSD license
        * Documentation: https://procrunner.readthedocs.io.
        
        
        Features
        --------
        
        * runs an external process and waits for it to finish
        * does not deadlock, no matter the process stdout/stderr output behaviour
        * returns the exit code, stdout, stderr (separately), and the total process
          runtime as a dictionary
        * process can run in a custom environment, either as a modification of
          the current environment or in a new environment from scratch
        * stdin can be fed to the process, the returned dictionary contains
          information how much was read by the process
        * stdout and stderr is printed by default, can be disabled
        * stdout and stderr can be passed to any arbitrary function for
          live processing
        * optionally enforces a time limit on the process
        
        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.5.1 (2018-04-27)
        ------------------
        
        * Fix Win32API dependency installation on Windows.
        
        0.5.0 (2018-04-26)
        ------------------
        
        * New keyword 'win32resolve' which only takes effect on Windows and is enabled
          by default. This causes procrunner to call the Win32 API FindExecutable()
          function to try and lookup non-.exe files with the corresponding name. This
          means .bat/.cmd/etc.. files can now be run without explicitly specifying
          their extension. Only supported on Python 2.7 and 3.5+.
        
        0.4.0 (2018-04-23)
        ------------------
        
        * Python 2.7 support on Windows. Python3 not yet supported on Windows.
        
        0.3.0 (2018-04-17)
        ------------------
        
        * run_process() renamed to run()
        * Python3 compatibility fixes
        
        0.2.0 (2018-03-12)
        ------------------
        
        * Procrunner is now Python3 3.3-3.6 compatible.
        
        0.1.0 (2018-03-12)
        ------------------
        
        * First release on PyPI.
        
Keywords: procrunner
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Libraries :: Python Modules
