https://github.com/cwood/sshed

Minimal SSH wrapper around paramiko
https://github.com/cwood/sshed

paramiko python ssh

Last synced: about 1 year ago
JSON representation

Minimal SSH wrapper around paramiko

• Host: GitHub
• URL: https://github.com/cwood/sshed
• Owner: cwood
• Created: 2012-08-26T23:12:08.000Z (almost 14 years ago)
• Default Branch: master
• Last Pushed: 2015-03-23T21:06:41.000Z (over 11 years ago)
• Last Synced: 2025-05-01T15:58:06.515Z (about 1 year ago)
• Topics: paramiko, python, ssh
• Language: Python
• Homepage: http://cwood.github.com/sshed/
• Size: 302 KB
• Stars: 11
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

          
sshed

===================

sshed is a minimal paramiko/ssh2 wrapper that makes working with ssh through

python just like working with it in normal SSH. It will use your configuration

that you have already created first then any extra options can be passed in

through the library that is using it. Servers are base objects that can be

extended to do other tasks. Also the API is dead simple.

Documentation / Repo Information:

---------------------------------

* Documentation: http://sshed.readthedocs.org/en/latest/index.html

* Repo: https://github.com/cwood/sshed

Examples

-------------------

Creating a server from your ~/.ssh/config with ssh keys created. This also

uses a host alias

.. code-block:: python

    from sshed import servers

    server = servers.from_conf('development')

    server.run('whoami').output

    >> ['cwood']

    server.run('sudo whoami').output

    >> ['root']

    server.run('cd /var/www').returncode

    >> 0

    server.run('pwd').output

    >> ['/var/www']

Creating a server from just a hostname

.. code-block:: python

    from sshed import servers

    server = servers.from_conf('myserver.com')

    server.run('hostname').output

    >> ['myserver.com']

Uploading/Downloading from/to a server

.. code-block:: python

    from sshed import servers

    server = servers.from_conf('development')

    server.upload('/tmp/mytar.tar', '/var/tmp/mytar.tar')

    server.download('/var/logs/httpd/error_log', '/tmp/remote/error_log')

Creating a new server without a ssh config

.. code-block:: python

    from sshed.servers import Server

    server = Server(username='username', hostname='development.mycompany.com',

            password='supersecretpassword')

    server.run( ... )

Working with argparse. This sshed module also has a helper for working

with argparse. You can import an action so that when a user puts in a

``--server server.mycompany.com`` it will create a new server instance

for that server.

.. code-block:: python

    from sshed.argparse_actions import ServerAction

    # some other argparse information

    parser.add_argument('-s', '--server', action=ServerAction, dest='server')