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

Uploaded Source

Built Distributions

invoke-0.16.3-py3-none-any.whl (144.9 kB view details)

Uploaded Python 3

invoke-0.16.3-py2-none-any.whl (145.7 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for invoke-0.16.3.tar.gz
Algorithm Hash digest
SHA256 ee29c6744e1be7f3594dd8a5c854e085f76dbc8f0c906350141bec97e0f16def
MD5 6dec5a9697216fed617ab9ce1564b936
BLAKE2b-256 2aa694c230258d714640291334024162dfdc7e7d8c883f90eb0601f788cbf40d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-0.16.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b31b635792fcb2ceed4dbd62362455aaed6bfdf13996e2ec512e57ba4cac67ca
MD5 2eded8fe7dc267a87e3f97b4bd845317
BLAKE2b-256 c3b69dce1c0a7b08e7c21f5523dcbd0db706fafadbb352b57cb9be1908af3259

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-0.16.3-py2-none-any.whl
Algorithm Hash digest
SHA256 a1c825fcc213b6b1ee35a9483556bd8ade0ff549ac96132f58d679087cbfc57b
MD5 8417d2d3abc6c5aa0e715d86db1845cd
BLAKE2b-256 1c192b9f497d7ef4b7b27be5be4bfbb8c32b2c959da23cb2239447bb78e02499

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