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

Uploaded Source

Built Distributions

invoke-0.19.0-py3-none-any.whl (148.9 kB view details)

Uploaded Python 3

invoke-0.19.0-py2-none-any.whl (149.8 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for invoke-0.19.0.tar.gz
Algorithm Hash digest
SHA256 46378fd70681479e3ad75eff1d454d5635b8421193669f7ec3c5bb63a5a6eb82
MD5 ee515d5e8c6cd5d29f2bd59a76c0a649
BLAKE2b-256 c6a226e50e09e14e7bfd3f935d3d6b3e95408b293d08a1ffa3ffbeb80bcafd99

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-0.19.0-py3-none-any.whl
Algorithm Hash digest
SHA256 359da1ec07f52803053d680b0fa92b79afa2c734b7c9cad3395bb1b61e23b7a8
MD5 123da0c85fc7a277dab242bd77b7b995
BLAKE2b-256 c7a1c3ba87c61dfb52533494dde226101ccbc1cf048fa3f462b5710f9516dd16

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-0.19.0-py2-none-any.whl
Algorithm Hash digest
SHA256 555c6913035b3d5af8db421bdd30ea776b0a07a120132ae585fa2b59458dc039
MD5 093db86fe68aef4ce808d0a7349289cc
BLAKE2b-256 935f5949dc6644fc1003bc4d3c825225fe83bcd8347a1fb9cbca346c1f876eac

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