A utility for recording your internet speed.
Project description
Internet Speed Monitor
I've been curious to see how my internet speed varies during the day on my devices. As such, I decided to start collecting data.
Quickstart
Install the package:
pip install netspeedmonitor
Run the app from the command line:
netspeedmonitor app
If you'd like the app to run in the background:
netspeedmonitor app &
Be sure to take note of the process ID (PID) so that you can kill it as necessary.
To view the monitor UI, go to your [localhost in the browser on port 8501 (http://localhost:8501).
How this app works
Underneath the hood, we use the speedtest-cli
package
to send packets to Ookla's speed testing servers.
The results are then logged to a TinyDB.
To ensure atomic transactions, we use tinyrecord
.
Only a single instance of the app can be run per machine,
because we use [tendo
's] singleinstance
module
to ensure only a single instance runs on one machine.
(Running multiple instances may clog up your internet
especially if you are pinging Ookla's speed testing servers frequently,
so we only allow a single instance to be run per machine.
We use schedule
to run speedtest-cli
's speed testing functions
on a user-configurable interval.
Logging is made simple by using loguru
The UI is built using streamlit
;
it was super fast and easy to build, kudos to the team!
Precautions to take
speedtest-cli
sends about a few dozens of megabytes of data per test.
As such, if you're using metered internet
(i.e. one that has a data cap)
such as a hotspot on your phone,
you'll want to limit the frequency at which you ping Ookla's servers
or prevent the process from running in the background.
Your internet speed data is private and yours by default
The open source package stores data in your home directory.
By default it will store data at ~/.speedtest.json
.
(JSON is the default storage format for TinyDB.)
You can inspect the source;
by design, no measurement data is sent anywhere.
In fact, if you'd like to do your own analysis on the data, here's a code snippet that you can use to analyze it.
from tinydb import TinyDB
db = TinyDB("~/.speedtest.json")
df = pd.DataFrame(db.all())
Contributing and supporting the project
Contributions are welcome; support is even more welcome! Here's how you can help:
- Star the repo!
- Spread word about it on Twitter.
- Help test-drive the app.
- Test-drive the app on your Raspberry Pi.
- Make PRs to knock items off the roadmap.
Roadmap
- Changing storage location (lets you back up on cloud storage).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for netspeedmonitor-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 18f9980cda9b188766bcdf658dda6e2fea8ec37bde064d35cdfa6d07c43c2a80 |
|
MD5 | 09265e0b109b0a679e83e697b26f5fba |
|
BLAKE2b-256 | 65fb01ad96edfa03f247a4fc1a1a6ab0c6ac0de1b9932512ab1fc73e51b59dc6 |