invoke

package documentation
(source)

Undocumented

Module collection No module docstring; 1/1 class documented
Package completion No package docstring; 1/1 module documented
Module config No module docstring; 4/7 functions, 0/1 exception, 2/2 classes documented
Module context No module docstring; 2/2 classes documented
Module env Environment variable configuration loading class.
Module exceptions Custom exception classes.
Module executor No module docstring; 1/1 class documented
Module loader No module docstring; 2/2 classes documented
Module main Invoke's own 'binary' entrypoint.
Package parser Undocumented
Module program No module docstring; 1/1 class documented
Module runners No module docstring; 1/2 function, 4/4 classes documented
Module tasks This module contains the core `.Task` class & convenience decorators used to generate new tasks.
Module terminals Utility functions surrounding terminal devices & I/O.
Module util No module docstring; 0/2 variable, 0/1 constant, 4/6 functions, 1/1 class documented
Package vendor No package docstring; 1/1 module, 0/3 package documented
Module watchers No module docstring; 3/3 classes documented
Module __main__ Undocumented
Module _version Undocumented

From __init__.py:

Function run Run ``command`` in a subprocess and return a `.Result` object.
Function sudo Run ``command`` in a ``sudo`` subprocess and return a `.Result` object.
def run(command, **kwargs): (source)

Run ``command`` in a subprocess and return a `.Result` object. See `.Runner.run` for API details. .. note:: This function is a convenience wrapper around Invoke's `.Context` and `.Runner` APIs. Specifically, it creates an anonymous `.Context` instance and calls its `~.Context.run` method, which in turn defaults to using a `.Local` runner subclass for command execution. .. versionadded:: 1.0

def sudo(command, **kwargs): (source)

Run ``command`` in a ``sudo`` subprocess and return a `.Result` object. See `.Context.sudo` for API details, such as the ``password`` kwarg. .. note:: This function is a convenience wrapper around Invoke's `.Context` and `.Runner` APIs. Specifically, it creates an anonymous `.Context` instance and calls its `~.Context.sudo` method, which in turn defaults to using a `.Local` runner subclass for command execution (plus sudo-related bits & pieces). .. versionadded:: 1.4