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

Uploaded Source

Built Distributions

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

Uploaded Python 3

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

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for invoke-0.20.1.tar.gz
Algorithm Hash digest
SHA256 c4befd48e3aa967a76a8d97696919880c0bf5de01ca11ca3307f7e6b80c679d3
MD5 bb7d568a189db16e30efa55b95f5d06f
BLAKE2b-256 06ee0833a11b766122bdb16668e4d60d18eacb4973e95854c920e2ff2704e0ca

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-0.20.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2e8313b76c8d0c487ec5333b5731848390d070eb131f47a09dad8e2c29532420
MD5 f913d27738a551b499d9c2e9a345105f
BLAKE2b-256 25c27a1b42d36f7ff86934685bace58a4e2e6848ab9ef3003c820f72c3b917f8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-0.20.1-py2-none-any.whl
Algorithm Hash digest
SHA256 578ef92fa7963e31947ddbb4cc82544f9c1f0e34216f76dfc4df00dc955eb524
MD5 fc6df66ebddcbd6c7c645f007a5eb71d
BLAKE2b-256 ec7d8df73c3571420c4c435aa691c26bd1c50f889b9832ce9b60f56ee5595a36

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