Files
envoy/README.rst
2017-01-15 12:21:57 -05:00

40 lines
760 B
ReStructuredText

Envoy: Python Subprocesses for Humans.
======================================
**Note:** `Delegator <https://github.com/kennethreitz/delegator.py>`_ is a replacement for Envoy.
This is a convenience wrapper around the `subprocess` module.
You don't need this.
.. image:: https://github.com/kennethreitz/envoy/raw/master/ext/in_action.png
But you want it.
Usage
-----
Run a command, get the response::
>>> r = envoy.run('git config', data='data to pipe in', timeout=2)
>>> r.status_code
129
>>> r.std_out
'usage: git config [options]'
>>> r.std_err
''
Pipe stuff around too::
>>> r = envoy.run('uptime | pbcopy')
>>> r.command
'pbcopy'
>>> r.status_code
0
>>> r.history
[<Response 'uptime'>]