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

Uploaded Source

Built Distributions

invoke-0.18.0-py3-none-any.whl (148.1 kB view details)

Uploaded Python 3

invoke-0.18.0-py2-none-any.whl (148.9 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for invoke-0.18.0.tar.gz
Algorithm Hash digest
SHA256 bf3b0ac98371e8936cb40f326b461db6c11e30525aa4174b1afe877df2e64d12
MD5 3843abaef3c7f42bf02336fc94d4aa56
BLAKE2b-256 dc9cc08f2b78cf54622428108ef19b95364234ad6fa42114e8116297094bff9a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-0.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 79ca20347d9491c13a1b0eb1c2c795a9a0f8ecc1123b82ab666b02cdc71ab350
MD5 dddbe967e463e6829de0ab24e2fd9420
BLAKE2b-256 9e6452a529d8e588c209da83c9bb6fcb939be8cb1eb8c85170344c201279cc96

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-0.18.0-py2-none-any.whl
Algorithm Hash digest
SHA256 042574c4a0935c3a0c0f9cdf631fda37235ee80ca8f8bb6ac1caeab1448763ff
MD5 b1300d9aadaefe64606615a1ce77c843
BLAKE2b-256 22a5db2c014b796841f728d7a3afe80fc4926f70389879f8ed5f63bdc1646707

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