Skip to content

Commit b8d796d

Browse files
committed
Initial release
0 parents  commit b8d796d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+5861
-0
lines changed

AUTHORS

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Vincent Jaulin <vincent.jaulin@keyphrene.com>
2+
Sofian Brabez <sbz@wallix.com>
3+
Olivier Hervieu <ohe@wallix.com>

COPYING

Lines changed: 513 additions & 0 deletions
Large diffs are not rendered by default.

ChangeLog

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2010-02-09 Sofian Brabez <sbz@wallix.com>
2+
3+
* First release

INSTALL

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
=========
2+
pylibssh2
3+
=========
4+
5+
.. Generate an HTML page with "rst2html.py INSTALL > install.html"
6+
.. rst2html.py is part of the docutils software suite.
7+
8+
.. contents:: **Index**
9+
.. sectnum::
10+
11+
12+
Prerequisites
13+
=============
14+
15+
Here is the list of prerequisite software to run pylibssh2. The versions are
16+
the ones I develop with. It may work with earlier versions, but I can't
17+
guaranty anything.
18+
19+
* `libssh2 <http://www.libssh2.org>`_ 1.2.1+
20+
* `python <http://python.org/>`_ 2.6+
21+
22+
Install the software
23+
====================
24+
25+
Get the latest version of `pylibssh2`_.
26+
27+
.. _ `pylibssh2`: http://pypi.python.org/packages/source/p/pylibssh2/
28+
29+
Untar the tarball in the directory of your choice::
30+
31+
$ tar zxvf pylibssh2-{version}.tar.gz
32+
33+
Now enter in the pylibssh2-{version} directory.
34+
35+
Run the following command::
36+
37+
# python setup.py install
38+
39+
or
40+
41+
$ sudo python setup.py install

MANIFEST.in

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
include AUTHORS ChangeLogCOPYING INSTALL README
2+
recursive-include src *.c *.h
3+
recursive-include examples *

Makefile

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
#
2+
# Copyright (c) 2010 Wallix Inc.
3+
# All rights reserved.
4+
#
5+
# Redistribution and use in source and binary forms, with or without
6+
# modification, are permitted provided that the following conditions
7+
# are met:
8+
#
9+
# * Redistributions of source code must retain the above copyright
10+
# notice, this list of conditions and the following disclaimer.
11+
# * Redistributions in binary form must reproduce the above copyright
12+
# notice, this list of conditions and the following disclaimer in the
13+
# documentation and/or other materials provided with the distribution.
14+
# * Neither the name of the author nor the names of any co-contributors
15+
# may be used to endorse or promote products derived from this software
16+
# without specific prior written permission.
17+
#
18+
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19+
# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20+
# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21+
# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22+
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23+
# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24+
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25+
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26+
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27+
# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28+
#
29+
TARGET=libssh2
30+
PY_TARGET=py${TARGET}
31+
DEBIAN_TARGET=python-libssh2
32+
33+
build: clean
34+
python setup.py clean
35+
python setup.py build --force
36+
37+
install: build
38+
sudo python setup.py install
39+
40+
installdeb:
41+
sudo dpkg -i ../${DEBIAN_TARGET}*.deb
42+
43+
dist:
44+
python setup.py sdist --format=gztar
45+
46+
deb:
47+
dpkg-buildpackage -tc
48+
49+
doc:
50+
epydoc --no-private -n ${PY_TARGET} -o doc ${TARGET}
51+
52+
clean:
53+
rm -rf build dist
54+
rm -rf MANIFEST *.egg-info
55+
rm -rf ${PY_TARGET}/*pyc
56+
57+
cleandoc:
58+
rm -rf doc
59+
60+
cleandeb:
61+
rm -rf ../*.deb ../*.dsc ../*.tar.gz ../*.changes
62+
63+
distclean: clean cleandoc cleandeb

README

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

debian/README.Debian

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
The Debian Package python-libssh2
2+
---------------------------------
3+
4+
Comments regarding the Package
5+
6+
-- Sofian Brabez <sbz@wallix.com> Thu, 26 Nov 2009 23:10:49 +0100

debian/changelog

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
pylibssh2 (1.0.0) unstable; urgency=low
2+
3+
* Initial Release.
4+
5+
-- Sofian Brabez <sbz@wallix.com> Tue, 8 Dec 2009 17:10:49 +0100

debian/compat

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
7

0 commit comments

Comments
 (0)