Netmeasure

A library for measuring Internet connection quality in a structured and consistent way.

Purpose

There are a variety of services, clients, tools, and methodologies used to measure Internet connection quality. Each of these has its own advantages, flaws, biases and units of measurement.

Netmeasure brings together a variety of Internet connection quality measurements in a single library with a consistent interface and explicitly-defined units.

An open-source license ensures methodology is transparent and open to ongoing community improvement.

Measurements

• 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.

Usage

...

Requirements

netmeasure supports Python 3.8 to Python 3.11 inclusively.

Development

Git hooks

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
asd

Publishing a release

1. Install poetry

2. Checkout the release:

   $ git checkout v<x>.<y>.<z>
   

3. Publish the release:

   $ poetry publish --build