Updated changelog, readme, rtd configuration (#32)

* Updated changelog, readme, rtd configuration
* Updated setup.py, key C file
* Updated manylinux scripts, docker file, krb archive and openssl version.
* Updated manylinux binary wheel openssl to 1.1
* Lfs track xz
* Updated embedded openssh test server

Author: pkittenis

.gitattributes

@@ -1,3 +1,4 @@
 *.tar.gz filter=lfs diff=lfs merge=lfs -text
 *.rpm filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text

Changelog.rst

@@ -1,6 +1,21 @@
 Change Log
 =============
 
+0.8.0
++++++
+
+Changes
+--------
+
+* Updated supported key types in ``ssh.keytypes`` for libssh 0.9.5.
+* Added certificate import and handling functions to ``ssh.key``
+
+Packaging
+---------
+
+* Updated OpenSSL in manylinux wheels to 1.1
+* Added Python 3.9 Windows 64-bit binary wheel
+
 0.7.0
 +++++
 

README.rst

@@ -27,57 +27,27 @@ _____________
 
 Binary wheels are provided for Linux (manylinux 2010), OSX (10.14 and 10.15 for brew Python), and Windows 64-bit (Python 3.6/3.7/3.8).
 
-Wheels have *no dependencies*. For building from source, see `documentation <http://ssh-python.readthedocs.org/en/latest/>`_.
+Wheels have *no dependencies*.
+
+For building from source, see `documentation <https://ssh-python.readthedocs.io/en/latest/installation.html#building-from-source>`_.
 
 
 .. code-block:: shell
 
    pip install ssh-python
 
+Pip may need to be updated to be able to install binary wheels.
 
-Project is beta status, please report any issues.
+.. code-block:: shell
+
+   pip install -U pip
+   pip install ssh-python
 
 
 Quick Start
 _____________
 
-
-.. code-block:: python
-
-   from __future__ import print_function
-
-   import os
-   import pwd
-
-   from ssh.session import Session
-   from ssh import options
-
-   # Linux only
-   USERNAME = pwd.getpwuid(os.geteuid()).pw_name
-   HOST = 'localhost'
-
-   s = Session()
-   s.options_set(options.HOST, HOST)
-   s.connect()
-
-   # Authenticate with agent
-   s.userauth_agent(USERNAME)
-
-   chan = s.channel_new()
-   chan.open_session()
-   chan.request_exec('echo me')
-   size, data = chan.read()
-   while size > 0:
-       print(data.strip())
-       size, data = chan.read()
-   chan.close()
-
-Output:
-
-.. code-block:: shell
-
-  me
-
+See `command execution script <https://github.com/ParallelSSH/ssh-python/blob/master/examples/exec.py>`_ for complete example.
 
 Features
 _________

ci/travis/build-manylinux.sh ci/build-manylinux.sh

@@ -2,11 +2,11 @@
 
 docker_tag="parallelssh/ssh-manylinux"
 
-rm -rf build ssh/libssh.*
+rm -rf local build ssh/libssh.* ssh/*.so
 python ci/appveyor/fix_version.py .
 
 docker pull $docker_tag || echo
 docker build --pull --cache-from $docker_tag ci/docker/manylinux -t $docker_tag
 if [[ -z "$CIRCLE_PULL_REQUEST" ]]; then docker push $docker_tag; fi
-docker run --rm -v `pwd`:/io $docker_tag /io/ci/travis/build-wheels.sh
+docker run --rm -v `pwd`:/io $docker_tag /io/ci/build-wheels.sh
 ls wheelhouse/

ci/travis/build-wheels.sh ci/build-wheels.sh

@@ -1,22 +1,23 @@
 FROM quay.io/pypa/manylinux2010_x86_64
 
-ENV OPENSSL openssl-1.0.2p
+ENV OPENSSL openssl-1.1.1g
 ENV LIBSSH 0.9.5
 ENV SYSTEM_LIBSSH 1
 
 RUN yum install zlib-devel cmake3 -y
 
 ADD libssh-${LIBSSH}.tar.xz libssh.tar.xz
-ADD ${OPENSSL}.tar.gz ${OPENSSL}.tar.gz
-ADD krb5-1.18.2.tar.gz krb5-1.18.2.tar.gz
+ADD https://www.openssl.org/source/${OPENSSL}.tar.gz ${OPENSSL}.tar.gz
+ADD krb5-1.18.2.tar.xz krb5-1.18.2.tar.xz
 
+RUN tar -xzf ${OPENSSL}.tar.gz
 # Openssl
-RUN cd ${OPENSSL}.tar.gz/${OPENSSL} && \
+RUN cd ${OPENSSL} && \
     ./config --prefix=/usr --openssldir=/usr/openssl threads shared && \
     make -j6 && make install
 
 # Kerberos
-RUN cd krb5-1.18.2.tar.gz/krb5-1.18.2/src && \
+RUN cd krb5-1.18.2.tar.xz/krb5-1.18.2/src && \
     ./configure && \
     make -j6 && \
     make install
@@ -27,8 +28,6 @@ RUN mkdir -p build_libssh && cd build_libssh && \
           -DWITH_GSS_API=ON && \
     make -j6 install
 
-
-RUN rm -rf ${OPENSSL}* libssh build_libssh krb5-1.18.2.tar.gz
-
+RUN rm -rf ${OPENSSL}* libssh build_libssh krb5-1.18.2.tar.xz
 
 VOLUME /var/cache

ci/docker/manylinux/Dockerfile

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5edbf866236e0b0ec9e8ab67593f8824ea88666c4190d2d2746519fb71691377
+size 6268820

ci/docker/manylinux/krb5-1.18.2.tar.gz

@@ -12,7 +12,6 @@
 #
 # import os
 # import sys
-# sys.path.insert(0, os.path.abspath('.'))
 
 import ssh
 
@@ -51,7 +50,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -93,7 +92,11 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-# html_theme_options = {}
+html_theme_options = {
+    'navigation_depth': 2,
+    'collapse_navigation': False,
+    'display_version': True,
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

ci/docker/manylinux/krb5-1.18.2.tar.xz

@@ -53,6 +53,7 @@
     'boundscheck': False,
     'optimize.use_switch': True,
     'wraparound': False,
+    'language_level': 2,
 }
 cython_args = {
     'cython_directives': cython_directives,