walkero
/
speedtest-cli
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity
Command line interface for testing internet bandwidth using speedtest.net
87 Commits 23 Branches 30 Tags 1.1 MiB
Python 67.3%
C 31.6%
Roff 0.9%
Makefile 0.2%
Go to file
Mustafa Jamil a3ca5ed4c2 Added function for simple module-like usage 
The speedtest_cli code is awesome, but not written to be consumed as a
module. To facilitate its usage by other developers, a simple function -
basic_speedtest() - has been added that returns the speedtest data as a
simple tuple. This change is additive and restricted to default/silent
options. A proper refactoring could be done to enable such module-like
usage the correct way, but this is an acceptable, safe, and
easy-to-validate alternative.
 		2014-02-24 19:18:39 -08:00
.gitignore Initial commit 2012-09-10 12:17:53 -07:00
.travis.yml Add .travis.yml 2014-02-17 20:14:41 -06:00
CONTRIBUTING.md Add reference to permitted modules 2014-02-08 18:18:34 -06:00
LICENSE LICENSE 2013-04-26 22:37:03 -05:00
MANIFEST.in Add MANIFEST.in 2013-10-08 07:15:42 -05:00
README.rst Fix double slash 2014-02-20 17:07:53 -06:00
setup.py Bump version to 0.2.5 2014-02-17 20:16:24 -06:00
speedtest-cli.1 Properly escape minus signs so that they don't become hyphens 2014-02-10 22:24:43 +02:00
speedtest_cli.py Added function for simple module-like usage 2014-02-24 19:18:39 -08:00

README.rst 

speedtest-cli
=============

Command line interface for testing internet bandwidth using
speedtest.net

.. image:: https://pypip.in/v/speedtest-cli/badge.png
        :target: https://pypi.python.org/pypi/speedtest-cli/
        :alt: Latest Version
.. image:: https://pypip.in/d/speedtest-cli/badge.png
        :target: https://pypi.python.org/pypi/speedtest-cli/
        :alt: Downloads
.. image:: https://pypip.in/license/speedtest-cli/badge.png
        :target: https://pypi.python.org/pypi/speedtest-cli/
        :alt: License

Versions
--------

speedtest-cli works with Python 2.4-3.4

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
    python speedtest-cli/setup.py install

Just download (Like the way it used to be)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

::

    wget -O speedtest-cli https://raw.github.com/sivel/speedtest-cli/master/speedtest_cli.py
    chmod +x speedtest-cli

or

::

    curl -o speedtest-cli https://raw.github.com/sivel/speedtest-cli/master/speedtest_cli.py
    chmod +x speedtest-cli

Usage
-----

::

    $ speedtest-cli -h
    usage: speedtest-cli [-h] [--share] [--simple] [--list] [--server SERVER]
                         [--mini MINI] [--source SOURCE] [--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
      --share          Generate and provide a URL to the speedtest.net share
                       results image
      --simple         Suppress verbose output, only show basic information
      --list           Display a list of speedtest.net servers sorted by distance
      --server SERVER  Specify a server ID to test against
      --mini MINI      URL of the Speedtest Mini server
      --source SOURCE  Source IP address to bind to
      --version        Show the version number and exit