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

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

# Usage

This tool will attempt to use the `ssh` config in `~/.ssh/config` for fields not provided.
```bash
usage: speedtest-ssh [-h] [--version] [-u USERNAME] [--password PASSWORD]
                     [--port PORT] [--num_seconds NUM_SECONDS]
                     [-m {rsync,sftp}]
                     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
  --num_seconds NUM_SECONDS
                        An approximate amount of time this test should take
  -m {rsync,sftp}, --mode {rsync,sftp}
                        The speedtest method. Defaults to rsync
```

# Notes

1. This will be subject to your disk read/write speed in `/tmp` on both devices
