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.7 and 3.4+) 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 {}".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.22.0.tar.gz (292.1 kB view details)

Uploaded Source

Built Distributions

invoke-0.22.0-py3-none-any.whl (154.6 kB view details)

Uploaded Python 3

invoke-0.22.0-py2-none-any.whl (155.5 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for invoke-0.22.0.tar.gz
Algorithm Hash digest
SHA256 6c572a09849e1452ff65c674d4531a940366278194af86315e458f8457192274
MD5 be42731648e039f4ed768266e8f4c4eb
BLAKE2b-256 ccbddf3422a7bdd5b87e20b498bcec9d4722db4a697cc9cd476fbb068bec8339

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-0.22.0-py3-none-any.whl
Algorithm Hash digest
SHA256 66434bf48dcffea232e8ada3a7e252cc10928871c46f39ece123c6a5753c0d0c
MD5 dbf923e5d554c8b95cfc44a6702caf36
BLAKE2b-256 2faa704d05da1d71c0653f2d841429fdecca366994f78cb18b574dc3388612b6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-0.22.0-py2-none-any.whl
Algorithm Hash digest
SHA256 a90acf9fd9d863dba4545b369c4ca547de4ca76228ca52c78cf224e7eecce0e9
MD5 3528488bf1a55322ad60d7ac7c0fe48f
BLAKE2b-256 1833198081460535d3b329c5f3e6eb14b9a99c252d41ae09e3f536ef44c0570e

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