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

Uploaded Source

Built Distributions

invoke-0.20.0-py3-none-any.whl (151.8 kB view details)

Uploaded Python 3

invoke-0.20.0-py2-none-any.whl (152.6 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for invoke-0.20.0.tar.gz
Algorithm Hash digest
SHA256 6cd73cca1146040839892e8cd890bbd2fee1a16fe8b094616b3b97a855a584c7
MD5 fc76eb401e9dfa958a7e84a8c577d2f5
BLAKE2b-256 611c741681d52820576a86b661ab9256faef4e4e4dddf51779ccd5275a154b40

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-0.20.0-py3-none-any.whl
Algorithm Hash digest
SHA256 715fe2237eda36448bcf77da55dfb9f781478ad9da4ac36b4d9005b039aa878c
MD5 2bc3b7b01f2fea8ceb915f6c68741f39
BLAKE2b-256 e4d790f60ee8fb0bf937f6a77557931f06b345b611e55a73b093a5b696997b8d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-0.20.0-py2-none-any.whl
Algorithm Hash digest
SHA256 aae85515239ad99369f70e5fc94cfb1c214d2372c2ae7ee65e2f81c37e6b4a5d
MD5 3c9d1b9472687fcc88494dc7d7dcd612
BLAKE2b-256 4f7b2d0c5bde1c363892047d93ac50f83f631a4f2b7824856f67c61b26e7cebe

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