From fa756fbc95402ea565e17bc840bc868743dd191a Mon Sep 17 00:00:00 2001
From: Thomas Kluyver <thomas@kluyver.me.uk>
Date: Thu, 12 Jul 2018 22:13:39 +0200
Subject: Add note to pxssh doc inviting people to consider Paramiko

---
 doc/api/pxssh.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'doc')

diff --git a/doc/api/pxssh.rst b/doc/api/pxssh.rst
index b947f4b..c9c80c6 100644
--- a/doc/api/pxssh.rst
+++ b/doc/api/pxssh.rst
@@ -1,6 +1,14 @@
 pxssh - control an SSH session
 ==============================
 
+.. note::
+
+   *pxssh* is a screen-scraping wrapper around the SSH command on your system.
+   In many cases, you should consider using
+   `Paramiko <https://github.com/paramiko/paramiko>`_ instead.
+   Paramiko is a Python module which speaks the SSH protocol directly, so it
+   doesn't have the extra complexity of running a local subprocess.
+
 .. automodule:: pexpect.pxssh
 
 .. autoclass:: ExceptionPxssh
-- 
cgit v1.2.1