You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,25 +1,27 @@
1
1
ssh-python
2
2
============
3
3
4
-
Wrapper for libssh_ C library.
5
-
4
+
Bindings for libssh_ C library.
6
5
7
6
Installation
8
7
_____________
9
8
10
9
Currently only installation from source is provided. Binary wheels to follow.
11
10
12
-
To install from source, run the following after cloning the repository
11
+
To install from source, run the following:
13
12
14
13
.. code-block:: shell
15
14
16
-
python setup.py install
15
+
pip install ssh-python
16
+
17
+
18
+
Project is beta status.
17
19
18
20
19
21
Prerequisites
20
22
--------------
21
23
22
-
* OpenSSL library and development headers
24
+
* OpenSSL *or* gcrypt library and development headers
23
25
* Optionally Zlib library and development headers for compression
24
26
25
27
``Libssh`` source code is embedded in this project and will be built when installation is triggered per above instructions. Versions of ``libssh`` other than the one embedded in this project are not supported.
@@ -71,8 +73,7 @@ _________
71
73
The library uses `Cython`_ based native code extensions as wrappers to ``libssh``.
72
74
73
75
* Thread safe - GIL is released as much as possible
74
-
* Very low overhead
75
-
* Super fast as a consequence of the excellent C library it uses and prodigious use of native code
76
+
* Very low overhead thin wrapper
76
77
* Object oriented - memory freed automatically and safely as objects are garbage collected by Python
77
78
* Use Python semantics where applicable, such as context manager and iterator support for opening and reading from channels and SFTP file handles
0 commit comments