A CLI tool and Python library for measuring Internet connection quality in a structured and consistent way.
Many services, clients, tools, and methodologies exist to measure Internet connection quality. Each of these has particular advantages, flaws, biases and units of measurement.
netmeasure brings together a variety of Internet connection quality measurements in a single package, with a consistent interface and explicitly-defined units.
An open-source license ensures methodology is transparent and open to ongoing community improvement.
netmeasure supports Python 3.8 to Python 3.11 inclusively.
netmeasure can be used to run measurements directly from the command line.
Install with pipx:
$ pipx install netmeasureUse netmeasure --help to see a list of available measurements:
Usage: netmeasure [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...
Internet connection quality measurements.
Options:
-v, --verbose
--help Show this message and exit.
Commands:
file_download Perform a file download measurement.
ip_route Perform an ip route measurement.
latency Perform a latency measurement.
netflix_fast Perform a Netflix fast.com measurement.
speedtest_dotnet Perform a speedtest.net measurement.
webpage_download Perform a webpage download measurement.
youtube_download Perform a youtube download measurement.Use netmeasure <measurement> --help for details for a specific measurement:
netmeasure netflix_fast --help
Usage: netmeasure netflix_fast [OPTIONS]
Perform a Netflix fast.com measurement.
Options:
--help Show this message and exit.$ netmeasure netflix_fast
─────────────────────────────────────────────────────────────────────────────────────────────────────────────
🍿 Netflix Fast 🍿
Host 0: ipv4-c003-syd001-superloop-isp.1.oca.nflxvideo.net | Country: AU | City: Alexandria
Host 1: ipv4-c004-syd002-superloop-isp.1.oca.nflxvideo.net | Country: AU | City: Sydney
Host 2: ipv4-c001-meb002-superloop-isp.1.oca.nflxvideo.net | Country: AU | City: Port Melbourne
Download Rate: 25393008.677629545 bit/s | Download Size: 54657024.0 B
─────────────────────────────────────────────────────────────────────────────────────────────────────────────Measurements can be performed sequentially by chaining commands:
$ netmeasure \
netflix_fast \
latency --host 1.1.1.1
speedtest_dotnet
─────────────────────────────────────────────────────────────────────────────────────────────────────────────
🍿 Netflix Fast 🍿
Host 0: ipv4-c003-syd001-superloop-isp.1.oca.nflxvideo.net | Country: AU | City: Alexandria
Host 1: ipv4-c004-syd002-superloop-isp.1.oca.nflxvideo.net | Country: AU | City: Sydney
Host 2: ipv4-c001-meb002-superloop-isp.1.oca.nflxvideo.net | Country: AU | City: Port Melbourne
Download Rate: 25393008.677629545 bit/s | Download Size: 54657024.0 B
─────────────────────────────────────────────────────────────────────────────────────────────────────────────
─────────────────────────────────────────────────────────────────────────────────────────────────────────────
🏓 Latency 🏓
Host: 1.1.1.1
Minimum Latency: 4.403 ms | Average Latency: 107.408 ms | Maximum Latency: 313.408 ms |Median Deviation: 145.663 ms
Packets Transmitted: 3 | Packets Received: 3 | Packets Lost: 0.0 %
Elapsed Time: 2002.0 ms
─────────────────────────────────────────────────────────────────────────────────────────────────────────────
─────────────────────────────────────────────────────────────────────────────────────────────────────────────
⚡ Speedtest Dotnet ⚡
Host: st-syd-02.gcomm.com.au:8080 | Name: Sydney | ID: 29570 | Sponsor: Nexon Asia Pacific
Download Rate: 25007776.530098625 bit/s | Upload Rate: 19202829.854627796 bit/s
─────────────────────────────────────────────────────────────────────────────────────────────────────────────netmeasure can be used as a library to run measurements and obtain structured results from within your application.
Install from PyPI:
$ pip install -U netmeasure
importuuidfrompprintimportpprint# Import the required measurement.fromnetmeasure.measurements.latency.measurementsimportLatencyMeasurement# Create a measurement.# Note: A measurement requires an id. This id will be added to all results# generated by this measurement instance.my_latency_measurement=LatencyMeasurement(id=str(uuid.uuid4()), host='1.1.1.1')
# Run the measurement.my_result=my_latency_measurement.measure()
# Print the measurement result(s)pprint(my_result)[LatencyMeasurementResult(id='fb6f0c59-e6dc-4f3f-8139-c8b4b2d94871'),
errors=[],
host='1.1.1.1',
minimum_latency=3.939,
average_latency=4.195,
maximum_latency=4.361,
median_deviation=0.164,
packets_transmitted=4,
packets_received=4,
packets_lost=0.0,
packets_lost_unit=<RatioUnit.percentage: '%'>,
elapsed_time=3004.0,
elapsed_time_unit=<TimeUnit.millisecond: 'ms'>)]Take a look at the commands defined in netmeasure/cli.py for more examples.
The following measurements are currently available:
file_download- measures download of a file from a given endpoint using the wget application.ip_route- measures network hops to a given endpoint using the scapy library.latency- measures latency to a given endpoint using the ping application.netflix_fast- measures download from the netflix fast service using the requests library.speedtest_dotnet- measures download from, upload to and latency to the speedtest.net service using the speedtest-cli library.webpage_download- measures download of a given web page and its associated assets using the requests library.youtube_download- measures download of a given youtube video using the youtube-dl library.
Note: Some measurements require particular cli tools to be installed
pre-commit hooks are included to ensure code quality
on commit and push. Install these hooks like so:
$ pre-commit install && pre-commit install -t pre-push