Pythonic task management & command execution.
Python Other
Permalink
Failed to load latest commit information.
appveyor Add support for CI with Appveyor Mar 5, 2015
completion Get basic --collection matching working for zsh completion Apr 29, 2015
integration A Python 2.7-ism snuck in at one point Jan 13, 2017
invoke Make sure DataProxy/Config are explicitly unhashable on Py2. Jan 23, 2017
sites Make sure DataProxy/Config are explicitly unhashable on Py2. Jan 23, 2017
tests Make sure DataProxy/Config are explicitly unhashable on Py2. Jan 23, 2017
.coveragerc Update coverage stuff to use .coveragerc, and add codecov. Dec 22, 2015
.gitignore Some tools generate coverage.xml now whee Dec 22, 2015
.travis.yml Talk about fail Dec 20, 2016
LICENSE Happy New Year Jan 1, 2017
MANIFEST.in Tidy up MANIFEST.in so source distro includes tasks.py, etc. Feb 8, 2016
README.rst README tweak Dec 5, 2016
THOUGHTS.rst Make shit moved to THOUGHTS re: parameterization actually make sense … Jun 15, 2015
appveyor.yml
dev-requirements.txt Sphinx 1.5 seems to have dropped py2.6 support :( Dec 5, 2016
setup.cfg Make sure flake8 skips the new Travis alt_env... Feb 9, 2016
setup.py Add Windows trove classifier (also shuffle order because why not). Jun 11, 2016
tasks-requirements.txt Update coverage stuff to use .coveragerc, and add codecov. Dec 22, 2015
tasks.py Explicit changelog file for invocations releases junk Nov 7, 2016
tox.ini

README.rst

Invoke is a Python (2.6+ and 3.3+) task execution tool & library, drawing inspiration from various sources to arrive at a powerful & clean feature set.

  • Like Ruby's Rake tool and Invoke's own predecessor Fabric 1.x, it provides a clean, high level API for running shell commands and defining/organizing task functions from a tasks.py file:

    from invoke import task
    
    @task
    def clean(ctx, docs=False, bytecode=False, extra=''):
        patterns = ['build']
        if docs:
            patterns.append('docs/_build')
        if bytecode:
            patterns.append('**/*.pyc')
        if extra:
            patterns.append(extra)
        for pattern in patterns:
            ctx.run("rm -rf %s" % pattern)
    
    @task
    def build(ctx, docs=False):
        ctx.run("python setup.py build")
        if docs:
            ctx.run("sphinx-build docs docs/_build")
  • From GNU Make, it inherits an emphasis on minimal boilerplate for common patterns and the ability to run multiple tasks in a single invocation:

    $ invoke clean build
    
  • Where Fabric 1.x considered the command-line approach the default mode of use, Invoke (and tools built on it) are equally at home embedded in your own Python code or a REPL:

    >>> from invoke import run
    >>> result = run("pip install -r requirements.txt", hide=True, warn=True)
    >>> print(result.ok)
    True
    >>> print(result.stdout[-1])
    Successfully installed invocations-0.13.0 pep8-1.5.7 spec-1.3.1
    >>>
    
  • Following the lead of most Unix CLI applications, it offers a traditional flag-based style of command-line parsing, deriving flag names and value types from task signatures (optionally, of course!):

    $ invoke clean --docs --bytecode build --docs --extra='**/*.pyo'
    $ invoke clean -d -b build --docs -e '**/*.pyo'
    $ invoke clean -db build -de '**/*.pyo'
    
  • Like many of its predecessors, it offers advanced features as well -- namespacing, task aliasing, before/after hooks, parallel execution and more.

For documentation, including detailed installation information, please see http://pyinvoke.org. Post-install usage information may be found in invoke --help.

You can install the development version via pip install -e git+https://github.com/pyinvoke/invoke#egg=invoke.