speedtest-cli/README.rst

152 lines
5.3 KiB
ReStructuredText
Raw Normal View History

speedtest-cli
=============
Command line interface for testing internet bandwidth using
speedtest.net
.. image:: https://img.shields.io/pypi/v/speedtest-cli.svg
2014-02-18 16:25:22 +01:00
:target: https://pypi.python.org/pypi/speedtest-cli/
:alt: Latest Version
2018-02-05 23:33:01 +01:00
.. image:: https://img.shields.io/travis/sivel/speedtest-cli.svg
2014-02-21 00:07:53 +01:00
:target: https://pypi.python.org/pypi/speedtest-cli/
2018-02-05 23:33:01 +01:00
:alt: Travis
.. image:: https://img.shields.io/pypi/l/speedtest-cli.svg
2014-02-18 16:25:22 +01:00
:target: https://pypi.python.org/pypi/speedtest-cli/
:alt: License
Versions
--------
2018-02-05 23:33:07 +01:00
speedtest-cli works with Python 2.4-3.7
.. image:: https://img.shields.io/pypi/pyversions/speedtest-cli.svg
:target: https://pypi.python.org/pypi/speedtest-cli/
:alt: Versions
Installation
------------
pip / easy\_install
~~~~~~~~~~~~~~~~~~~
::
pip install speedtest-cli
or
::
easy_install speedtest-cli
Github
~~~~~~
::
pip install git+https://github.com/sivel/speedtest-cli.git
or
::
git clone https://github.com/sivel/speedtest-cli.git
2013-09-17 15:42:21 +02:00
python speedtest-cli/setup.py install
Just download (Like the way it used to be)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
2016-05-27 18:32:36 +02:00
wget -O speedtest-cli https://raw.githubusercontent.com/sivel/speedtest-cli/master/speedtest.py
chmod +x speedtest-cli
or
::
2016-05-27 18:32:36 +02:00
curl -Lo speedtest-cli https://raw.githubusercontent.com/sivel/speedtest-cli/master/speedtest.py
chmod +x speedtest-cli
Usage
-----
::
$ speedtest-cli -h
usage: speedtest-cli [-h] [--no-download] [--no-upload] [--bytes] [--share]
[--simple] [--csv] [--csv-delimiter CSV_DELIMITER]
[--csv-header] [--json] [--list] [--server SERVER]
2017-11-23 17:30:31 +01:00
[--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
2017-11-23 17:30:31 +01:00
optional arguments:
2015-12-22 22:53:26 +01:00
-h, --help show this help message and exit
--no-download Do not perform download test
--no-upload Do not perform upload test
2015-12-22 22:53:26 +01:00
--bytes Display values in bytes instead of bits. Does not
2016-11-04 16:04:17 +01:00
affect the image generated by --share, nor output from
--json or --csv
2015-12-22 22:53:26 +01:00
--share Generate and provide a URL to the speedtest.net share
results image, not displayed with --csv
2015-12-22 22:53:26 +01:00
--simple Suppress verbose output, only show basic information
--csv Suppress verbose output, only show basic information
2016-09-13 16:02:29 +02:00
in CSV format. Speeds listed in bit/s and not affected
by --bytes
2015-12-22 22:53:26 +01:00
--csv-delimiter CSV_DELIMITER
Single character delimiter to use in CSV output.
Default ","
2016-09-13 16:02:29 +02:00
--csv-header Print CSV headers
2015-12-22 22:53:26 +01:00
--json Suppress verbose output, only show basic information
2016-09-13 16:02:29 +02:00
in JSON format. Speeds listed in bit/s and not
affected by --bytes
2015-12-22 22:53:26 +01:00
--list Display a list of speedtest.net servers sorted by
distance
2017-11-23 17:30:31 +01:00
--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
2015-12-22 22:53:26 +01:00
--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
2015-12-22 22:53:26 +01:00
--version Show the version number and exit
2017-03-24 21:31:02 +01:00
Python API
----------
See the `wiki <https://github.com/sivel/speedtest-cli/wiki>`_.
Inconsistency
-------------
It is not a goal of this application to be a reliable latency reporting tool.
Latency reported by this tool should not be relied on as a value indicative of ICMP
style latency. It is a relative value used for determining the lowest latency server
for performing the actual speed test against.
There is the potential for this tool to report results inconsistent with Speedtest.net.
There are several concepts to be aware of that factor into the potential inconsistency:
1. Speedtest.net has migrated to using pure socket tests instead of HTTP based tests
2. This application is written in Python
3. Different versions of Python will execute certain parts of the code faster than others
4. CPU and Memory capacity and speed will play a large part in inconsistency between
Speedtest.net and even other machines on the same network
Issues relating to inconsistencies will be closed as wontfix and without
additional reason or context.