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(c, 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:
            c.run("rm -rf {}".format(pattern))
    
    @task
    def build(c, docs=False):
        c.run("python setup.py build")
        if docs:
            c.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-1.0.0.tar.gz (330.0 kB view details)

Uploaded Source

Built Distributions

invoke-1.0.0-py3-none-any.whl (159.3 kB view details)

Uploaded Python 3

invoke-1.0.0-py2-none-any.whl (160.1 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for invoke-1.0.0.tar.gz
Algorithm Hash digest
SHA256 21274204515dca62206470b088bbcf9d41ffda82b3715b90e01d71b7a4681921
MD5 57029399beb57a06d4afbfc2b09c82e4
BLAKE2b-256 d2cd9011fec068cac5e44aa0314cbe72866ccac85b13fe6eea0a2a707e855ffd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4a4cc031db311cbfb3fdd8ec93a06c892533c27b931f4be14b24c97cd042b14e
MD5 cdb9b35c6ca045b38b5cdf1a2299c80a
BLAKE2b-256 6c669e232c59e61f0a0b6552d68419a5c5a5dba368e105fdbfd2b6c74c402234

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-1.0.0-py2-none-any.whl
Algorithm Hash digest
SHA256 621b6564f992c37166e16090d7e7cccb3b922e03a58e980dfa5e543a931b652f
MD5 2fddf476b4108f527b77c5a578665dcd
BLAKE2b-256 25b74bbe1147246466040f914c91d96dbd3f9a5dce2a567dccf323691d0bc0eb

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