From 0621c291896ab32602afbdd5f58ea09cdcd15499 Mon Sep 17 00:00:00 2001 From: VisualPlugin Date: Wed, 16 Oct 2024 02:39:22 +0000 Subject: [PATCH] Update README.rst --- README.rst | 61 ++++++++++++++++++++---------------------------------- 1 file changed, 22 insertions(+), 39 deletions(-) diff --git a/README.rst b/README.rst index 7a98f31..528ce57 100644 --- a/README.rst +++ b/README.rst @@ -17,7 +17,7 @@ speedtest.net Versions -------- -speedtest-cli works with Python 2.4-3.7 +speedtest-cli works with Python 2.4-3.12 .. image:: https://img.shields.io/pypi/pyversions/speedtest-cli.svg :target: https://pypi.python.org/pypi/speedtest-cli/ @@ -75,54 +75,37 @@ Usage :: $ speedtest-cli -h - usage: speedtest-cli [-h] [--no-download] [--no-upload] [--single] [--bytes] - [--share] [--simple] [--csv] - [--csv-delimiter CSV_DELIMITER] [--csv-header] [--json] - [--list] [--server SERVER] [--exclude EXCLUDE] - [--mini MINI] [--source SOURCE] [--timeout TIMEOUT] - [--secure] [--no-pre-allocate] [--version] - - Command line interface for testing internet bandwidth using speedtest.net. - -------------------------------------------------------------------------- + usage: speedtest.py [-h] [--no-download] [--no-upload] [--single] [--bytes] [--units {Mibyte,Mbyte,Mibit,Mbit,Kibyte,Kbyte,Kibit,Kbit,byte,bit}] [--share] + [--simple] [--csv] [--csv-delimiter CSV_DELIMITER] [--csv-header] [--json] [--list] [--server SERVER] [--exclude EXCLUDE] [--mini MINI] + [--source SOURCE] [--timeout TIMEOUT] [--secure] [--no-pre-allocate] [--version] + + Command line interface for testing internet bandwidth using speedtest.net. -------------------------------------------------------------------------- https://github.com/sivel/speedtest-cli - - optional arguments: + + options: -h, --help show this help message and exit --no-download Do not perform download test --no-upload Do not perform upload test - --single Only use a single connection instead of multiple. This - simulates a typical file transfer. - --bytes Display values in bytes instead of bits. Does not - affect the image generated by --share, nor output from - --json or --csv - --share Generate and provide a URL to the speedtest.net share - results image, not displayed with --csv + --single Only use a single connection instead of multiple. This simulates a typical file transfer. + --bytes Display values in bytes instead of bits. Does not affect the image generated by --share, nor output from --json or --csv + --units {Mibyte,Mbyte,Mibit,Mbit,Kibyte,Kbyte,Kibit,Kbit,byte,bit} + Determines which units to display values in. Does not affect the image generated by --share, nor output from --json or --csv + --share Generate and provide a URL to the speedtest.net share results image, not displayed with --csv --simple Suppress verbose output, only show basic information - --csv Suppress verbose output, only show basic information - in CSV format. Speeds listed in bit/s and not affected - by --bytes + --csv Suppress verbose output, only show basic information in CSV format. Speeds listed in bit/s and not affected by --bytes or --units --csv-delimiter CSV_DELIMITER - Single character delimiter to use in CSV output. - Default "," + Single character delimiter to use in CSV output. Default "," --csv-header Print CSV headers - --json Suppress verbose output, only show basic information - in JSON format. Speeds listed in bit/s and not - affected by --bytes - --list Display a list of speedtest.net servers sorted by - distance - --server SERVER Specify a server ID to test against. Can be supplied - multiple times - --exclude EXCLUDE Exclude a server from selection. Can be supplied - multiple times + --json Suppress verbose output, only show basic information in JSON format. Speeds listed in bit/s and not affected by --bytes or --units + --list Display a list of speedtest.net servers sorted by distance + --server SERVER Specify a server ID to test against. Can be supplied multiple times + --exclude EXCLUDE Exclude a server from selection. Can be supplied multiple times --mini MINI URL of the Speedtest Mini server --source SOURCE Source IP address to bind to --timeout TIMEOUT HTTP timeout in seconds. Default 10 - --secure Use HTTPS instead of HTTP when communicating with - speedtest.net operated servers - --no-pre-allocate Do not pre allocate upload data. Pre allocation is - enabled by default to improve upload performance. To - support systems with insufficient memory, use this - option to avoid a MemoryError + --secure Use HTTPS instead of HTTP when communicating with speedtest.net operated servers + --no-pre-allocate Do not pre allocate upload data. Pre allocation is enabled by default to improve upload performance. To support systems with + insufficient memory, use this option to avoid a MemoryError --version Show the version number and exit