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.3.tar.gz (2.2 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for sshed-0.2.3.tar.gz
Algorithm Hash digest
SHA256 75906abcdb1fd3bdc49f9cae0b32b2c593abdb17fa9560e222c73f3b0e3557f4
MD5 c6b778e416d044bdf049e4dad58c5a2b
BLAKE2b-256 bbdc12a1d91579604849abae5499b5f400b0b394aa107d81a080e06a3eeb9121

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