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:

    fakeout = “”” Hello, this is pip Installing is fun Fake output is fake Successfully installed invocations-0.13.0 pep8-1.5.7 spec-1.3.1 “”” proc = MockSubprocess(out=fakeout, exit=0)

    proc.stop()

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

Uploaded Source

Built Distributions

invoke-0.16.2-py3-none-any.whl (144.9 kB view details)

Uploaded Python 3

invoke-0.16.2-py2-none-any.whl (145.7 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for invoke-0.16.2.tar.gz
Algorithm Hash digest
SHA256 7b2379659d4181b48c33af478b9c5c62da62896cbe4969c1becfe7439fd92a12
MD5 bc1a899fcd3c1feb5143491fdb2948c6
BLAKE2b-256 733ca7dc07f5fce60a64388b718d47e754b552d34c52abf5765ebfb5133f383a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-0.16.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d6d0755ad2f5dea7bff1421e42bb8db89043cc7558603f07f27382db43aa0f3c
MD5 222b39b7fe800506bdac70c0f8c69009
BLAKE2b-256 2a5867dead8b17e42b3bc71355b905ce018c695b9c249b5af50cc1287602c1c1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-0.16.2-py2-none-any.whl
Algorithm Hash digest
SHA256 5961c6d58eaef2cad2653612ba9473954cb2a932df0c19a50792e56f859a8e70
MD5 e4d46888de3a82cf67a9fff3900c0cd3
BLAKE2b-256 a6dd8f94be675298439df73d7d00e48764228b3c59a345569a10e90a945fe9f3

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