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

Uploaded Source

Built Distributions

invoke-0.20.4-py3-none-any.whl (152.4 kB view details)

Uploaded Python 3

invoke-0.20.4-py2-none-any.whl (153.2 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for invoke-0.20.4.tar.gz
Algorithm Hash digest
SHA256 ecb322fd48b3d3405aedb882cdeaa99b6f51aca12893659ca8a60b01d6173f47
MD5 a82559df72c10c0ffc4e9d5e417fa031
BLAKE2b-256 9e905d99067c8bf86d5c5ba281891d6bb613163d5ae7b14a3885738bfc945757

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-0.20.4-py3-none-any.whl
Algorithm Hash digest
SHA256 a7459684c2a06e0b517b4e8d14029607b0902adf920272ae43b600c2d121278c
MD5 088bbc63c08ac1574f41027a5c01a967
BLAKE2b-256 5c861eaf42589e4fab1112f1c8379e90eadf674490d5ee31a060e8737712313f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-0.20.4-py2-none-any.whl
Algorithm Hash digest
SHA256 f249b4de4d2cde01f908d870b30769bdc9e43906df6ee1d8415504f51c111c4f
MD5 a9ce0fcf516592a5db68fe5c968d94f8
BLAKE2b-256 6563ebdd4160a8432191ccb26948d068c7379cd36e1fdb5cb50c313581638aa4

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