1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
=========
pylibssh2
=========
:libssh2: Python module
:Copyright: Keyphrene, Wallix
:License: LGPL
:Homepage: http://www.wallix.org/index.php/category/pylibssh2
pylibssh2 1.0.0
================
1.0.0 release, X may 2010
What
----
pylibssh2 is a python binding for libssh2 library, it was forked and rewrote
from scratch using old org.keyphrene (http://sourceforge.net/projects/orgkeyphrene/)
bindings.
I wrote this extension at Wallix (http://wallix.com) to provide an easy
way to manage SSH2 connection through libssh2 library in python.
This is a C extension module to provide a high level python API. libssh2 API is
fairy well respected and export into a python API.
Packaging and API is documented with epydoc format.
Requirements
------------
- python 2.6+ <http://www.python.org>
(older version before 2.5 aren't supported and not recommended)
- libssh2 1.2.1+ <http://www.libssh2.org>
(older version after 0.18 can works too)
Linux Debian/Ubuntu::
sudo aptitude install python2-6 libssh2-1 libssh2-1-dev
FreeBSD::
sudo make -C /usr/ports/lang/python install clean
sudo make -C /usr/ports/security/libssh2/ install clean
License
-------
Old parts from Keyphrene.org are licensied against GNU Lesser GPL (LGPL) and all
new and rewritten parts from Wallix.com are licensied against LGPL License too.
Portability
-----------
I code and test this binding on Linux and FreeBSD. It would be works on all
posix platforms but I haven't tried others.
Bugs & Support
---------------
Bug tracker is available at
https://bugs.wallix.org/
Mailing list for support and discussions at
http://www.wallix.org/mailman/listinfo/pylibssh2
Get the source code
git clone http://github.com/wallix/pylibssh2.git
Browse the source code at
http://github.com/wallix/pylibssh2.git
Download tarballs at
http://pypi.python.org/packages/source/p/pylibssh2/
Example
-------
:scp_upload.py:
dummy version of scp upload file transfer with pylibssh2.
:sftp_listdir.py:
this example show how to use pylibssh2 to list remote directories through
SFTP protocol.
:ssh_exec.py:
this example show how to execute a SSH remote command execution.
:ssh.py:
this example demonstrate how implement a partial ssh client to get a remote
shell.
:ssh_x11.py:
this example show how to implement a X11 fowarding ssh client.
Documentation
-------------
API documentation can be generated with epydoc <http://epydoc.sourceforge.net/>
with following command line::
epydoc --no-private -n pylibssh2 -o doc libssh2
Install
-------
See the INSTALL file for installation instructions.
Don't hesitate to reports bugs and submit patches, or just mail author.
|
