Skip to main content

Minimal Parmaiko/ssh2 wrapper to make working with SSH easy.

Project description

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.

```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
```python
from sshed import servers
server = servers.from_conf('myserver.com')
server.run('hostname').output
>> ['myserver.com']
```

Uploading/Downloading from/to a server
```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
```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.

Example:

```python
from sshed.argparse_actions import ServerAction

# some other argparse information
parser.add_argument('-s', '--server', action=ServerAction, dest='server')
```

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sshed-0.2.1.tar.gz (3.9 kB view details)

Uploaded Source

File details

Details for the file sshed-0.2.1.tar.gz.

File metadata

  • Download URL: sshed-0.2.1.tar.gz
  • Upload date:
  • Size: 3.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for sshed-0.2.1.tar.gz
Algorithm Hash digest
SHA256 5d15253e3a861a0dca2f49cbdd5dfada3e7c225ef9c53334f628540cfa30f919
MD5 e50cab43023715aeb3b6ae5b10fad075
BLAKE2b-256 85bc4d0917a6b3c56a53a06f58a81134ac401687fe7113745b70c77006800e86

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page