Skip to main content

Pythonic task execution

Project description

To find out what’s new in this version of Invoke, please see the changelog.

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 {0}".format(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
    >>> cmd = "pip install -r requirements.txt"
    >>> result = run(cmd, hide=True, warn=True)
    >>> print(result.ok)
    True
    >>> print(result.stdout.splitlines()[-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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

invoke-0.17.0.tar.gz (274.7 kB view details)

Uploaded Source

Built Distributions

invoke-0.17.0-py3-none-any.whl (146.0 kB view details)

Uploaded Python 3

invoke-0.17.0-py2-none-any.whl (146.8 kB view details)

Uploaded Python 2

File details

Details for the file invoke-0.17.0.tar.gz.

File metadata

  • Download URL: invoke-0.17.0.tar.gz
  • Upload date:
  • Size: 274.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for invoke-0.17.0.tar.gz
Algorithm Hash digest
SHA256 981103f08e2aa7ada37a415da09be76ec4023a9dceb0475d51a00ad10ff8ea51
MD5 76054d9e4a3239676f61f05e9a6a5e63
BLAKE2b-256 f8cb0aced931a57f9e8169f32f1f1234524a4d779de5e060b3c29708c7135f41

See more details on using hashes here.

File details

Details for the file invoke-0.17.0-py3-none-any.whl.

File metadata

File hashes

Hashes for invoke-0.17.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0ce43ce89585a0fc4346c98a9f5e8f0d051b048943108f274982e1486e969905
MD5 e0c9eb1625f54681daff928139fbe53a
BLAKE2b-256 7e48987914534afdd82345bddfffa9accec2ca14cc6d9c53fc539d94d85b1f30

See more details on using hashes here.

File details

Details for the file invoke-0.17.0-py2-none-any.whl.

File metadata

File hashes

Hashes for invoke-0.17.0-py2-none-any.whl
Algorithm Hash digest
SHA256 44704a3f0c8d8923738361898709121656e48e95c3a9f0608594577fca02060c
MD5 f7e8ec361b6b107f4fe396c49a45c7db
BLAKE2b-256 6702a4582c32487ab96f12babf67b6530b6372a3ab87a9826a8efdcd577d7270

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page