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.18.1.tar.gz (278.4 kB view details)

Uploaded Source

Built Distributions

invoke-0.18.1-py3-none-any.whl (148.3 kB view details)

Uploaded Python 3

invoke-0.18.1-py2-none-any.whl (149.1 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for invoke-0.18.1.tar.gz
Algorithm Hash digest
SHA256 a239148c4cd9ff91a103204472599148007600424520ec1dcf2e8c7826531902
MD5 1ef6298ece56deaf2ae5ad3635447215
BLAKE2b-256 17551ce0431c4c68976b22192909f15e37b6976fd8bdfedf8f413207eddbc746

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-0.18.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9357fef14a7825bacdfaf75b62e4b7f2d8874cd5378b3e41a48cc8af6dffe5f2
MD5 6b7167804fb234d0e7e785b828a193da
BLAKE2b-256 2769e2dc1cd4932afca04da157c20b288a496815e0e14e4cccfd3913c9da3e64

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-0.18.1-py2-none-any.whl
Algorithm Hash digest
SHA256 243fb7332651d58130a07ce9f49b3464eeab090dcfb56f57708d0d4b7d635c56
MD5 384c335be2b344da620bf812f1ac595a
BLAKE2b-256 278c58ccf7a60359debeaed514da5de10c365909b21630c0c626932acd29ca04

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