Python 3.10 support

Fixes #628

.travis.yml

@@ -1,7 +1,6 @@
 language: python
-
+sudo: required
-python:
+dist: xenial
- - 2.7
 
 addons:
   apt:
@@ -11,23 +10,49 @@ addons:
       - python2.4
       - python2.5
       - python2.6
-      - pypy
+      - python3.2
+      - python3.3
 
-env:
+matrix:
- - TOXENV=py24
+  include:
- - TOXENV=py25
+    - python: 2.7
- - TOXENV=py26
+      env: TOXENV=flake8
- - TOXENV=py27
+    - python: 2.7
- - TOXENV=py32
+      env: TOXENV=py24
- - TOXENV=py33
+    - python: 2.7
- - TOXENV=py34
+      env: TOXENV=py25
- - TOXENV=py35
+    - python: 2.7
- - TOXENV=pypy
+      env: TOXENV=py26
- - TOXENV=flake8
+    - python: 2.7
+      env: TOXENV=py27
+    - python: 2.7
+      env: TOXENV=py32
+    - python: 2.7
+      env: TOXENV=py33
+    - python: 3.4
+      env: TOXENV=py34
+    - python: 3.5
+      env: TOXENV=py35
+    - python: 3.6
+      env: TOXENV=py36
+    - python: 3.7
+      env: TOXENV=py37
+    - python: 3.8-dev
+      env: TOXENV=py38
+    - python: pypy
+      env: TOXENV=pypy
+      dist: trusty
+
+before_install:
+  - if [[ $(echo "$TOXENV" | egrep -c "py35") != 0 ]]; then pyenv global system 3.5; fi;
 
 install:
+  - if [[ $(echo "$TOXENV" | egrep -c "py32") != 0 ]]; then pip install setuptools==17.1.1; fi;
   - if [[ $(echo "$TOXENV" | egrep -c "(py2[45]|py3[12])") != 0 ]]; then pip install virtualenv==1.7.2 tox==1.3; fi;
- - if [[ $(echo "$TOXENV" | egrep -c "(py2[45]|py3[12])") == 0 ]]; then pip install tox; fi;
+  - if [[ $(echo "$TOXENV" | egrep -c "(py26|py33)") != 0 ]]; then pip install virtualenv==15.2.0 tox==2.9.1; fi;
+  - if [[ $(echo "$TOXENV" | egrep -c "(py2[456]|py3[123])") == 0 ]]; then pip install tox; fi;
+
+
 
 script:
   - tox

README.rst

@@ -7,9 +7,9 @@ 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/pypi/dm/speedtest-cli.svg
+.. image:: https://img.shields.io/travis/sivel/speedtest-cli.svg
         :target: https://pypi.python.org/pypi/speedtest-cli/
-        :alt: Downloads
+        :alt: Travis
 .. image:: https://img.shields.io/pypi/l/speedtest-cli.svg
         :target: https://pypi.python.org/pypi/speedtest-cli/
         :alt: License
@@ -17,7 +17,7 @@ speedtest.net
 Versions
 --------
 
-speedtest-cli works with Python 2.4-3.5
+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/
@@ -51,7 +51,8 @@ or
 ::
 
     git clone https://github.com/sivel/speedtest-cli.git
-    python speedtest-cli/setup.py install
+    cd speedtest-cli
+    python setup.py install
 
 Just download (Like the way it used to be)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -74,10 +75,12 @@ Usage
 ::
 
     $ speedtest-cli -h
-    usage: speedtest-cli [-h] [--bytes] [--share] [--simple] [--csv]
+    usage: speedtest-cli [-h] [--no-download] [--no-upload] [--single] [--bytes]
+                         [--share] [--simple] [--csv]
                          [--csv-delimiter CSV_DELIMITER] [--csv-header] [--json]
-                         [--list] [--server SERVER] [--mini MINI] [--source SOURCE]
+                         [--list] [--server SERVER] [--exclude EXCLUDE]
-                         [--timeout TIMEOUT] [--secure] [--version]
+                         [--mini MINI] [--source SOURCE] [--timeout TIMEOUT]
+                         [--secure] [--no-pre-allocate] [--version]
 
     Command line interface for testing internet bandwidth using speedtest.net.
     --------------------------------------------------------------------------
@@ -85,11 +88,15 @@ Usage
 
     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
+                            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
@@ -103,14 +110,28 @@ Usage
                             affected by --bytes
       --list                Display a list of speedtest.net servers sorted by
                             distance
-      --server SERVER       Specify a server ID to test against
+      --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
 -------------
 

setup.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-# Copyright 2012-2016 Matt Martz
+# Copyright 2012 Matt Martz
 # All Rights Reserved.
 #
 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
@@ -66,7 +66,7 @@ setup(
     author_email='matt@sivel.net',
     url='https://github.com/sivel/speedtest-cli',
     license='Apache License, Version 2.0',
-    py_modules=['speedtest', 'speedtest_cli'],
+    py_modules=['speedtest'],
     entry_points={
         'console_scripts': [
             'speedtest=speedtest:main',
@@ -90,5 +90,10 @@ setup(
         'Programming Language :: Python :: 3.3',
         'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
     ]
 )

speedtest-cli.1

@@ -1,4 +1,4 @@
-.TH "speedtest-cli" 1 "2014-04-23" "speedtest-cli"
+.TH "speedtest-cli" 1 "2018-01-05" "speedtest-cli"
 .SH NAME
 speedtest\-cli \- Command line interface for testing internet bandwidth using speedtest.net
 .SH SYNOPSIS
@@ -23,14 +23,29 @@ Displays usage for the tool.
 
 .B Options
 
+\fB\-\-no\-download\fR
+.RS
+Do not perform download test
+.RE
+
+\fB\-\-no\-upload\fR
+.RS
+Do not perform upload test
+.RE
+
+\fB\-\-single\fR
+.RS
+Only use a single connection instead of multiple. This simulates a typical file transfer.
+.RE
+
 \fB\-\-bytes\fR
 .RS
-Display values in bytes instead of bits. Does not affect the image generated by \-\-share
+Display values in bytes instead of bits. Does not affect the image generated by \-\-share, nor output from \-\-json or \-\-csv
 .RE
 
 \fB\-\-share\fR
 .RS
-Generate and provide a URL to the speedtest.net share results image
+Generate and provide a URL to the speedtest.net share results image, not displayed with \-\-csv
 .RE
 
 \fB\-\-simple\fR
@@ -43,12 +58,12 @@ Suppress verbose output, only show basic information
 Suppress verbose output, only show basic information in CSV format. Speeds listed in bit/s and not affected by \-\-bytes
 .RE
 
-\fB\-\-csv-delimiter CSV_DELIMITER\fR
+\fB\-\-csv\-delimiter CSV_DELIMITER\fR
 .RS
 Single character delimiter to use in CSV output. Default ","
 .RE
 
-\fB\-\-csv-header\fR
+\fB\-\-csv\-header\fR
 .RS
 Print CSV headers
 .RE
@@ -65,7 +80,12 @@ Display a list of speedtest.net servers sorted by distance
 
 \fB\-\-server SERVER\fR
 .RS
-Specify a server ID to test against
+Specify a server ID to test against. Can be supplied multiple times
+.RE
+
+\fB\-\-exclude EXCLUDE\fR
+.RS
+Exclude a server from selection. Can be supplied multiple times
 .RE
 
 \fB\-\-mini MINI\fR
@@ -88,6 +108,11 @@ HTTP timeout in seconds. Default 10
 Use HTTPS instead of HTTP when communicating with speedtest.net operated servers
 .RE
 
+\fB\-\-no\-pre\-allocate\fR
+.RS
+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
+.RE
+
 \fB\-\-version\fR
 .RS
 Show the version number and exit

tests/scripts/source.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-# Copyright 2012-2016 Matt Martz
+# Copyright 2018 Matt Martz
 # All Rights Reserved.
 #
 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
@@ -15,20 +15,23 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
-import warnings
+import sys
+import subprocess
 
-DEPRECATED_MSG = ('The file speedtest_cli.py has been deprecated in favor of '
+cmd = [sys.executable, 'speedtest.py', '--source', '127.0.0.1']
-                  'speedtest.py\nand is available for download at:\n\n'
-                  'https://raw.githubusercontent.com/sivel/speedtest-cli/'
-                  'master/speedtest.py')
 
+p = subprocess.Popen(
+    cmd,
+    stdout=subprocess.PIPE,
+    stderr=subprocess.PIPE
+)
 
-if __name__ == '__main__':
+stdout, stderr = p.communicate()
-    raise SystemExit(DEPRECATED_MSG)
+
-else:
+if p.returncode != 1:
-    try:
+    raise SystemExit('%s did not fail with exit code 1' % ' '.join(cmd))
-        from speedtest import *
+
-    except ImportError:
+if 'Invalid argument'.encode() not in stderr:
-        raise SystemExit(DEPRECATED_MSG)
+    raise SystemExit(
-    else:
+        '"Invalid argument" not found in stderr:\n%s' % stderr.decode()
-        warnings.warn(DEPRECATED_MSG, UserWarning)
+    )

tox.ini

@@ -6,6 +6,8 @@ commands =
     {envpython} -V
     {envpython} -m compileall speedtest.py
     {envpython} speedtest.py
+    {envpython} speedtest.py --source 172.17.0.1
+    {envpython} tests/scripts/source.py
 
 [testenv:flake8]
 basepython=python
@@ -19,3 +21,5 @@ commands =
     pypy -V
     pypy -m compileall speedtest.py
     pypy speedtest.py
+    pypy speedtest.py --source 172.17.0.1
+    pypy tests/scripts/source.py