Skip to content

Updated readme, docs #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 6, 2025
Merged

Updated readme, docs #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
325e93b
Updated readme, docs
pkittenis Oct 6, 2025
56a2ec8
Updated docs
pkittenis Oct 6, 2025
e890189
Updated changelog
pkittenis Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions Changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ Changes
* Added `ssh.channel.Channel.get_exit_status` implementation and tests.


Packaging
----------

* OSX wheel builds now use embedded `libssh` rather than brew package.
* Dropped Windows Python 3.7 builds.
* Added Python 3.14 manylinux wheels.


1.1.1
+++++

Expand Down
7 changes: 3 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Bindings for libssh_ C library.
Installation
_____________

Binary wheels are provided for Linux (manylinux 2014, x86_64 and aarch64), OSX (12, 13 and 14 for brew Python), and Windows 64-bit (Python 3.7+).
Binary wheels are provided for Linux (manylinux 2014, x86_64 and aarch64), OSX (12, 13 and 14 for brew Python), and Windows 64-bit (Python 3.8+).

Wheels have *no dependencies*.

Expand All @@ -52,12 +52,12 @@ See `command execution script <https://github.com/ParallelSSH/ssh-python/blob/ma
Features
_________

The library uses `Cython`_ based native code extensions as wrappers to ``libssh``.
The library provides Python bindings to the ``libssh`` C library.

* Thread safe - GIL released as much as possible

* libssh threading limitations apply - anything not supported in C is not supported in Python
* Very low overhead thin wrapper
* Very low overhead bindings
* Object oriented

* Memory freed automatically and safely as objects are garbage collected by Python
Expand All @@ -69,4 +69,3 @@ The library uses `Cython`_ based native code extensions as wrappers to ``libssh`


.. _libssh: https://www.libssh.org
.. _Cython: https://www.cython.org
6 changes: 5 additions & 1 deletion doc/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ By default, the package will try to build against an embedded version of ``libss

To build against a system library, export the ``SYSTEM_LIBSSH=1`` environment variable prior to building.

Note that the library supports its embedded ``libssh`` version and only that version. Use previous ``ssh-python`` versions if wanting to build against older ``libssh`` versions. See `Changelog <Changelog.html>`_.

The following libraries are required:

* OpenSSL 1.0 or 1.1, >=1.1 for Ed25519 support
Expand Down Expand Up @@ -43,7 +45,7 @@ Building on Windows

Requirements:

* Python >= 3.6
* Python >= 3.8
* Visual Studio 14 or above
* OpenSSL 1.1
* Zlib
Expand All @@ -60,3 +62,5 @@ Steps
Note dependencies will need to be built statically to be distributable to other Windows systems.

Cygwin/MingW probably do not work.

No support is offered for building on Windows from source.