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 %s" % 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
    >>> result = run("pip install -r requirements.txt", hide=True, warn=True)
    >>> print(result.ok)
    True
    >>> print(result.stdout[-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.15.0.tar.gz (266.3 kB view details)

Uploaded Source

Built Distributions

invoke-0.15.0-py3-none-any.whl (143.5 kB view details)

Uploaded Python 3

invoke-0.15.0-py2-none-any.whl (144.4 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for invoke-0.15.0.tar.gz
Algorithm Hash digest
SHA256 0f98e515f94f6c67fc70eef0b34cd3d687f193e5c4df6482a29eb43b893caae7
MD5 de4d323b044753a5f5406b5e28141712
BLAKE2b-256 dea5888ea1999748774d528845d21b34e6f5ecc1a69acbc59f3191c54c026dbe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-0.15.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4c8b28319fde4a44b58bd2dc424d7ce22c084101fde1803b7daa69c80b8a7b48
MD5 22e5f11342c4b372f6a25847d5d77ec9
BLAKE2b-256 262df14560d2329e4f1465134b711db2284cf3217582804100ffcd174dbee401

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-0.15.0-py2-none-any.whl
Algorithm Hash digest
SHA256 f868ac74eacef35a83461dad584479895a1834b5b68a92e46d2adda8436a474f
MD5 c693e1760c363316708d1eb706cd72f7
BLAKE2b-256 8238ed38a64b43de03de8fdf170e046c0a8f2022c5c65771e150b0deca811652

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