Metadata-Version: 2.1
Name: speedtest-ssh
Version: 1.0.0
Summary: A tool meant to check inter-device speeds over ssh
License: GPL
Project-URL: Homepage, https://github.com/zwimer/speedtest_ssh
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: paramiko

# speedtest\_ssh
A simple tool for a quick and easy speedtest between two machines via ssh

# Usage

This tool will attempt to use the `ssh` config in `~/.ssh/config` for fields not provided.
```bash
$ speedtest_ssh --help
usage: speedtest_ssh [-h] [--version] [-u USERNAME] [--password PASSWORD] [--port PORT] [--max_seconds MAX_SECONDS] host

positional arguments:
  host                  The host to speedtest the conection to

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  -u USERNAME, --username USERNAME
                        The username to use to ssh
  --password PASSWORD   The password to use to ssh
  --port PORT           The port to use to ssh
  --max_seconds MAX_SECONDS
                        A soft limit for how many seconds to spend uploading / downloading
```
