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.7 and 3.4+) 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(c, 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:
            c.run("rm -rf {}".format(pattern))
    
    @task
    def build(c, docs=False):
        c.run("python setup.py build")
        if docs:
            c.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-1.1.0.tar.gz (309.8 kB view details)

Uploaded Source

Built Distributions

invoke-1.1.0-py3-none-any.whl (160.0 kB view details)

Uploaded Python 3

invoke-1.1.0-py2-none-any.whl (160.8 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for invoke-1.1.0.tar.gz
Algorithm Hash digest
SHA256 265eead8c89805a2ac5083200842db6da7636ac63fb4fe0d1121b930770f3e2a
MD5 60178dd52cac34e93f46d83f62f9dbbb
BLAKE2b-256 5c54bb21679f58d85574fe2a17addef3c9b619217758856b6ba1a7cbbdec26dd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1db6cf918e5df10efe4d61101b19763abe1510b6b2fe8c553daba25476de8044
MD5 1d4b1584a21dc586bd33421b9da94a5a
BLAKE2b-256 d049d7e5bc7fba721c7dc8d9ace297eeb67be1eee226d2abb9d89849cb167a23

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for invoke-1.1.0-py2-none-any.whl
Algorithm Hash digest
SHA256 3e8e2c2e69493227e210a1d19ccc7c44189240385dda4c9b8eb5d98fa0f68a3e
MD5 a31091e82e726dfc55c0664a7080c88d
BLAKE2b-256 799e6e54f429bad815e009cf175c6038561ae257ae0ea82c67804b0501cdaf83

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