Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
marian-code committed Dec 7, 2020
1 parent 980edac commit d05f84d
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -229,12 +229,24 @@ The last possibility is to instantiate each module by itself

.. code-block:: python
>>> from ssh_utilities import Connection, Os, Subprocess
>>> conn = Connection.get(<server_name>, <local>, <quiet>, <thread_safe>)
>>> remote_os = Os(conn)
>>> remote_subprocess = Subprocess(conn)
ssh_utilities now contains ``MultiConnection`` container which cleverly
manages multiple individual connections for you. You can carry out same
command across multiple servers asynchronously and many more! Detailed
information is in the docs.

.. code-block:: python
>>> from ssh_utilities import MultiConnection
>>> with MultiConnection(<server_names_list>, local=False,
thread_safe=True) as mc:
>>> mc.<some_attribute>
>>> ...
Contributing
------------
Expand Down

0 comments on commit d05f84d

Please sign in to comment.