Skip to content

Commit

Permalink
Updated read me.
Browse files Browse the repository at this point in the history
  • Loading branch information
pkittenis committed Oct 20, 2018
1 parent e875912 commit c3206df
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ script:
- export LD_LIBRARY_PATH=/usr/local/lib/x86_64-linux-gnu
- nosetests
- flake8 ssh2
# Test source distribution builds
- python setup.py sdist
- cd dist && pip install * && cd ..
- cd doc; make html; cd ..
Expand Down
11 changes: 5 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ At this time all of the `libssh2`_ API has been implemented up to version ``1.8.

Complete example scripts for various operations can be found in the `examples directory`_.

In addition, as ``ssh2-python`` is a thin wrapper of ``libssh2`` with Python semantics, its code examples can be ported straight over to Python with only minimal changes.
In addition, as ``ssh2-python`` is a thin wrapper of ``libssh2`` with Python semantics, `its code examples <https://libssh2.org/examples/>`_ can be ported straight over to Python with only minimal changes.


Library Features
Expand Down Expand Up @@ -96,6 +96,8 @@ Connect and get available authentication methods.
print(session.userauth_list())
Output will vary depending on SSH server configuration. For example:

.. code-block:: python
['publickey', 'password', 'keyboard-interactive']
Expand All @@ -104,7 +106,6 @@ Connect and get available authentication methods.
Agent Authentication
------------------------


.. code-block:: python
session.agent_auth(user)
Expand All @@ -113,7 +114,6 @@ Agent Authentication
Command Execution
------------------------


.. code-block:: python
channel = session.open_session()
Expand Down Expand Up @@ -154,16 +154,15 @@ Public Key Authentication
.. code-block:: python
session.userauth_publickey_fromfile(
username, 'my_pkey.pub', 'my_pkey', '')
username, 'private_key_file')
Where ``''`` can be a passphrase.
Passphrase can be provided with the ``passphrase`` keyword param - see `API documentation <https://ssh2-python.readthedocs.io/en/latest/session.html#ssh2.session.Session.userauth_publickey_fromfile>`_.


Password Authentication
----------------------------


.. code-block:: python
session.userauth_password(
Expand Down

0 comments on commit c3206df

Please sign in to comment.