Skip to content

Commit 946042c

Browse files
authored
Updated readme, docs (#100)
* Updated readme * Updated documentation * Updated changelog
1 parent 4cd5b63 commit 946042c

File tree

3 files changed

+16
-5
lines changed

3 files changed

+16
-5
lines changed

Changelog.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ Changes
1212
* Added `ssh.channel.Channel.get_exit_status` implementation and tests.
1313

1414

15+
Packaging
16+
----------
17+
18+
* OSX wheel builds now use embedded `libssh` rather than brew package.
19+
* Dropped Windows Python 3.7 builds.
20+
* Added Python 3.14 manylinux wheels.
21+
22+
1523
1.1.1
1624
+++++
1725

README.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Bindings for libssh_ C library.
2525
Installation
2626
_____________
2727

28-
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+).
28+
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+).
2929

3030
Wheels have *no dependencies*.
3131

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

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

5757
* Thread safe - GIL released as much as possible
5858

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

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

7070

7171
.. _libssh: https://www.libssh.org
72-
.. _Cython: https://www.cython.org

doc/installation.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ By default, the package will try to build against an embedded version of ``libss
1515

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

18+
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>`_.
19+
1820
The following libraries are required:
1921

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

4446
Requirements:
4547

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

6264
Cygwin/MingW probably do not work.
65+
66+
No support is offered for building on Windows from source.

0 commit comments

Comments
 (0)