Skip to content

Commit 3b880a0

Browse files
authored
Updated changelog (#218)
* Updated changelog * Updated readme, issue template
1 parent acd8872 commit 3b880a0

File tree

3 files changed

+24
-2
lines changed

3 files changed

+24
-2
lines changed

.github/issue_template.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
### Directions
22

33
_Issue tracker is for actionable bug reports, issues with the code and feature requests._
4-
_For general questions use the [mail group](https://groups.google.com/forum/#!forum/ssh2-python)._
4+
5+
_See [Discussions](https://github.com/ParallelSSH/ssh2-python/discussions) section for questions and discussions._
6+
57
_Remove this section and everything on and above this line._
68

79
### Bug reports

Changelog.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Packaging
1515

1616
* Added Windows Python 3.7 and 3.13 wheel builds.
1717
* Removed manylinux 2010 wheels.
18-
* Wheel builds now use embedded libssh and zlib.
18+
* Wheel builds now use embedded libssh2 and zlib.
1919
* Dockerfiles and scripts updates.
2020

2121
1.1.1

README.rst

+20
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,26 @@ Most developers will want to use the `high level clients <https://parallel-ssh.r
4242
in `parallel-ssh <https://github.com/ParallelSSH/parallel-ssh>`_
4343
based on this library.
4444

45+
46+
.. code-block:: shell
47+
48+
pip install parallel-ssh
49+
50+
51+
.. code-block:: python
52+
53+
from pssh.clients import SSHClient
54+
55+
host = 'localhost'
56+
cmd = 'uname'
57+
client = SSHClient(host)
58+
59+
host_out = client.run_command(cmd)
60+
for line in host_out.stdout:
61+
print(line)
62+
exit_code = host_out.exit_code
63+
64+
4565
This library provides bindings to the low-level libssh2 C-API. It is *not* high level, nor easy to use. A *lot* of code
4666
would need to be written to use this library that is already provided by `parallel-ssh`.
4767

0 commit comments

Comments
 (0)