speedtest-cli
=============
Command line interface for testing internet bandwidth using
speedtest.net
.. image:: https://img.shields.io/pypi/v/speedtest-cli.svg
:target: https://pypi.python.org/pypi/speedtest-cli/
:alt: Latest Version
.. image:: https://img.shields.io/travis/sivel/speedtest-cli.svg
:target: https://pypi.python.org/pypi/speedtest-cli/
:alt: Travis
.. image:: https://img.shields.io/pypi/l/speedtest-cli.svg
:target: https://pypi.python.org/pypi/speedtest-cli/
:alt: License
Versions
--------
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
cd speedtest-cli
python setup.py install
Just download (Like the way it used to be)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
wget -O speedtest-cli https://raw.githubusercontent.com/sivel/speedtest-cli/master/speedtest.py
chmod +x speedtest-cli
or
::
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] [--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.
--------------------------------------------------------------------------
https://github.com/sivel/speedtest-cli
optional arguments:
-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
--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-delimiter CSV_DELIMITER
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
--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
--version Show the version number and exit
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/sivel/",
"name": "netspeedtest",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4",
"maintainer_email": "",
"keywords": "speedtest-cli,http",
"author": "Matt Martz",
"author_email": "matt@sivel.net",
"download_url": "https://files.pythonhosted.org/packages/47/c1/ddddf70dc1f25d464abbf566b6afedaeba2bffb12d556fc2c97289996cdf/netspeedtest-1.0.0.tar.gz",
"platform": null,
"description": "speedtest-cli\n=============\n\nCommand line interface for testing internet bandwidth using\nspeedtest.net\n\n.. image:: https://img.shields.io/pypi/v/speedtest-cli.svg\n :target: https://pypi.python.org/pypi/speedtest-cli/\n :alt: Latest Version\n.. image:: https://img.shields.io/travis/sivel/speedtest-cli.svg\n :target: https://pypi.python.org/pypi/speedtest-cli/\n :alt: Travis\n.. image:: https://img.shields.io/pypi/l/speedtest-cli.svg\n :target: https://pypi.python.org/pypi/speedtest-cli/\n :alt: License\n\nVersions\n--------\n\nspeedtest-cli works with Python 2.4-3.7\n\n.. image:: https://img.shields.io/pypi/pyversions/speedtest-cli.svg\n :target: https://pypi.python.org/pypi/speedtest-cli/\n :alt: Versions\n\nInstallation\n------------\n\npip / easy\\_install\n~~~~~~~~~~~~~~~~~~~\n\n::\n\n pip install speedtest-cli\n\nor\n\n::\n\n easy_install speedtest-cli\n\nGithub\n~~~~~~\n\n::\n\n pip install git+https://github.com/sivel/speedtest-cli.git\n\nor\n\n::\n\n git clone https://github.com/sivel/speedtest-cli.git\n cd speedtest-cli\n python setup.py install\n\nJust download (Like the way it used to be)\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n::\n\n wget -O speedtest-cli https://raw.githubusercontent.com/sivel/speedtest-cli/master/speedtest.py\n chmod +x speedtest-cli\n\nor\n\n::\n\n curl -Lo speedtest-cli https://raw.githubusercontent.com/sivel/speedtest-cli/master/speedtest.py\n chmod +x speedtest-cli\n\nUsage\n-----\n\n::\n\n $ speedtest-cli -h\n usage: speedtest-cli [-h] [--no-download] [--no-upload] [--single] [--bytes]\n [--share] [--simple] [--csv]\n [--csv-delimiter CSV_DELIMITER] [--csv-header] [--json]\n [--list] [--server SERVER] [--exclude EXCLUDE]\n [--mini MINI] [--source SOURCE] [--timeout TIMEOUT]\n [--secure] [--no-pre-allocate] [--version]\n\n Command line interface for testing internet bandwidth using speedtest.net.\n --------------------------------------------------------------------------\n https://github.com/sivel/speedtest-cli\n\n optional arguments:\n -h, --help show this help message and exit\n --no-download Do not perform download test\n --no-upload Do not perform upload test\n --single Only use a single connection instead of multiple. This\n simulates a typical file transfer.\n --bytes Display values in bytes instead of bits. Does not\n affect the image generated by --share, nor output from\n --json or --csv\n --share Generate and provide a URL to the speedtest.net share\n results image, not displayed with --csv\n --simple Suppress verbose output, only show basic information\n --csv Suppress verbose output, only show basic information\n in CSV format. Speeds listed in bit/s and not affected\n by --bytes\n --csv-delimiter CSV_DELIMITER\n Single character delimiter to use in CSV output.\n Default \",\"\n --csv-header Print CSV headers\n --json Suppress verbose output, only show basic information\n in JSON format. Speeds listed in bit/s and not\n affected by --bytes\n --list Display a list of speedtest.net servers sorted by\n distance\n --server SERVER Specify a server ID to test against. Can be supplied\n multiple times\n --exclude EXCLUDE Exclude a server from selection. Can be supplied\n multiple times\n --mini MINI URL of the Speedtest Mini server\n --source SOURCE Source IP address to bind to\n --timeout TIMEOUT HTTP timeout in seconds. Default 10\n --secure Use HTTPS instead of HTTP when communicating with\n speedtest.net operated servers\n --no-pre-allocate Do not pre allocate upload data. Pre allocation is\n enabled by default to improve upload performance. To\n support systems with insufficient memory, use this\n option to avoid a MemoryError\n --version Show the version number and exit\n\n\nPython API\n----------\n\nSee the `wiki <https://github.com/sivel/speedtest-cli/wiki>`_.\n\n\nInconsistency\n-------------\n\nIt is not a goal of this application to be a reliable latency reporting tool.\n\nLatency reported by this tool should not be relied on as a value indicative of ICMP\nstyle latency. It is a relative value used for determining the lowest latency server\nfor performing the actual speed test against.\n\nThere is the potential for this tool to report results inconsistent with Speedtest.net.\nThere are several concepts to be aware of that factor into the potential inconsistency:\n\n1. Speedtest.net has migrated to using pure socket tests instead of HTTP based tests\n2. This application is written in Python\n3. Different versions of Python will execute certain parts of the code faster than others\n4. CPU and Memory capacity and speed will play a large part in inconsistency between\n Speedtest.net and even other machines on the same network\n\nIssues relating to inconsistencies will be closed as wontfix and without\nadditional reason or context.\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0",
"summary": "speedtest",
"version": "1.0.0",
"split_keywords": [
"speedtest-cli",
"http"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d10f261db55bf5a9f2e2a0db12b47c332cea3682bd108dc04f1b0a7f113a8176",
"md5": "e791fedb8d1702c481dbc65d77afd3ad",
"sha256": "bef9dd915ec98f06802b5b775953835235066495e07c410b330abdae14f8a887"
},
"downloads": -1,
"filename": "netspeedtest-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e791fedb8d1702c481dbc65d77afd3ad",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4",
"size": 23028,
"upload_time": "2023-03-11T14:29:48",
"upload_time_iso_8601": "2023-03-11T14:29:48.721571Z",
"url": "https://files.pythonhosted.org/packages/d1/0f/261db55bf5a9f2e2a0db12b47c332cea3682bd108dc04f1b0a7f113a8176/netspeedtest-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "47c1ddddf70dc1f25d464abbf566b6afedaeba2bffb12d556fc2c97289996cdf",
"md5": "a9bf3c6f62165151474648a823f8339f",
"sha256": "6a5fb0f1903023f61a4e6707654006fa5c41cadc605b85cb064279417b674e44"
},
"downloads": -1,
"filename": "netspeedtest-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "a9bf3c6f62165151474648a823f8339f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4",
"size": 22999,
"upload_time": "2023-03-11T14:29:51",
"upload_time_iso_8601": "2023-03-11T14:29:51.028382Z",
"url": "https://files.pythonhosted.org/packages/47/c1/ddddf70dc1f25d464abbf566b6afedaeba2bffb12d556fc2c97289996cdf/netspeedtest-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-11 14:29:51",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "netspeedtest"
}
JSON