Skip to content

README.rst

Latest commit

 

History

History
126 lines (87 loc) · 3.52 KB

README.rst

File metadata and controls

126 lines (87 loc) · 3.52 KB

iperf3-python: Python wrapper around iperf3

PyPi Status Build Status Coverage Status Documentation Status

Detailed documentation at iperf3-python.readthedocs.org

iperf3 for python provides a wrapper around the excellent iperf3 utility. iperf3 is a complete rewrite of the original iperf implementation. more information on the official iperf3 site

iperf3 introduced an API called libiperf that allows you to easily interact with iperf3 from other languages. This library provides a python wrapper around libiperf for easy integration into your own python scripts in a pythonic way

Installation

First you have to make sure the iperf3 utility is present on your system as the python module wraps around the libiperf API provided by it.

The common linux distributions offer installations from their own repositories. These might be out of date so installation from the official iperf3 website is preferred.

warning there seems to be an issue with iperf3 v3.0.7 causing a memory dump. To resolve this make sure to use the latest iperf3 version.

  • Install from source (preferred)
wget http://downloads.es.net/pub/iperf/iperf-3-current.tar.gz
tar xvf iperf-3-current.tar.gz
cd iperf-3.1.3/                # Or whatever the latest version is
./configure && make && make install
  • Ubuntu 16.04 LTS:
sudo apt-get install iperf3
  • CenOS/RedHat
sudo yum install iperf3

Once the iperf3 utility is installed the simplest way to install the python wrapper is through PyPi

pip install iperf3

You can also install directly from the github repository:

git clone https://github.com/thiezn/iperf3-python.git
cd iperf3-python
python3 setup.py install

Quickstart

For detailed examples check out the examples page

Server

>>> import iperf3

>>> server = iperf3.Server()
>>> result = server.run()
>>> result.remote_host
"10.10.10.10"

Client

>>> import iperf3

>>> client = iperf3.Client()
>>> client.duration = 1
>>> client.server_hostname = '127.0.0.1'
>>> client.port = 5201
>>> result = client.run()
>>> result.sent_Mbps
32583.293914794922

External Dependencies

  • iperf3
  • libiperf.0 (should come with iperf3

Testing

  • Tested against Ubuntu 14.04 LTS standard iperf3 installation using travis-ci
  • Test coverage reporting through coveralls.io
  • Tested against the following Python versions:
    • 2.6
    • 2.7
    • 3.3
    • 3.4
    • 3.5
    • 3.5-dev
    • nightly