summaryrefslogtreecommitdiff
path: root/debian/python-sh/usr/share/doc/python-sh/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'debian/python-sh/usr/share/doc/python-sh/README.md')
-rw-r--r--debian/python-sh/usr/share/doc/python-sh/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/debian/python-sh/usr/share/doc/python-sh/README.md b/debian/python-sh/usr/share/doc/python-sh/README.md
new file mode 100644
index 0000000..25ad1de
--- /dev/null
+++ b/debian/python-sh/usr/share/doc/python-sh/README.md
@@ -0,0 +1,16 @@
+sh (previously [pbs](http://pypi.python.org/pypi/pbs)) is a full-fledged
+subprocess interface for Python 2.6 - 3.2
+that allows you to call any program as if it were a function:
+
+```python
+from sh import ifconfig
+print ifconfig("eth0")
+```
+
+sh is not a collection of system commands implemented in Python.
+
+# Installation
+
+ $> pip install sh
+
+# Complete documentation @ http://amoffat.github.com/sh