Pythonic task execution
Project description
To find out what's new in this version of Invoke, please see `the changelog
<http://pyinvoke.org/changelog.html#0.16.1>`_.
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:
.. code-block:: python
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:
.. testsetup:: blurb
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)
.. testcleanup:: blurb
proc.stop()
.. doctest:: blurb
>>> 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``.
<http://pyinvoke.org/changelog.html#0.16.1>`_.
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:
.. code-block:: python
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:
.. testsetup:: blurb
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)
.. testcleanup:: blurb
proc.stop()
.. doctest:: blurb
>>> 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``.
Release history Release notifications | RSS feed
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.1.tar.gz
(287.9 kB
view details)
Built Distributions
invoke-0.16.1-py3-none-any.whl
(144.9 kB
view details)
invoke-0.16.1-py2-none-any.whl
(145.8 kB
view details)
File details
Details for the file invoke-0.16.1.tar.gz.
File metadata
- Download URL: invoke-0.16.1.tar.gz
- Upload date:
- Size: 287.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a043f49623b0dd493970dcb422276439a6e6422d7e49f39d3b235e05f7db2f0b |
|
| MD5 | c13dafa60075a99fdaba261bca42d581 |
|
| BLAKE2b-256 | 3b56927f1df51f6f73f443b0fbe7db48922d83d3f6dc963139e5716538633894 |
File details
Details for the file invoke-0.16.1-py3-none-any.whl.
File metadata
- Download URL: invoke-0.16.1-py3-none-any.whl
- Upload date:
- Size: 144.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4d76fc360834c2e419a80a946d9838de360d360419501b92ed43dedacfcf11c1 |
|
| MD5 | 02bc920ab7171da37ec6fc441252d590 |
|
| BLAKE2b-256 | 29fa72fba2b6629815ef6ac28e349b1778d0a8afca93910724ae13092f3c7975 |
File details
Details for the file invoke-0.16.1-py2-none-any.whl.
File metadata
- Download URL: invoke-0.16.1-py2-none-any.whl
- Upload date:
- Size: 145.8 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8f16d19b78978ae897c27ccf54daa1aff572f76f39a7044cd52df89cd836e74f |
|
| MD5 | c79fb338df0856d0ea0435614797ba9b |
|
| BLAKE2b-256 | a6175dee52cd575a1061bf221756f7b49fc5b28e983955b8af1f6fa9710c98c5 |
