Skip to content

Latest commit

 

History

History
68 lines (57 loc) · 3.02 KB

README.md

File metadata and controls

68 lines (57 loc) · 3.02 KB
Raw

speedcomplainer

A Python app that tests your internet connection and then complains to your Internet Service Provider (and logs to a data store if you'd like). May not be for the faint of heart.

It requires Python 2. Also check out requirements.txt for other required dependencies.

Online at:

https://twitter.com/not_GigaSpeed

  • option to add a random Chuck Norris joke at the end to keep you and your slow provider entertained (assuming your internet is fast enough to load it...)

Configuration

Configuration is handled by a basic JSON file. Things that can be configured are:

  • twitter API - get your credentials from https://developer.twitter.com/
    • twitterToken: This is your app access token
    • twitterConsumerKey: This is your Consumer Key (API Key)
    • twitterTokenSecret: This is your Access Token Secret
    • twitterConsumerSecret: This is your Consumer Secret (API Secret)
  • tweetTo: This is a account (or list of accounts) that will be @ mentioned (include the @!)
  • internetSpeed: This is the downstream speed (in Mb/sec) you're paying for (and presumably not getting).
  • internetUpSpeed: This is the upstream speed (in Mb/sec) you're paying for (and presumably not getting).
  • tweetThresholds: This is a list of messages that will be tweeted when you hit a threshold of crappiness.
  • Placeholders in the Tweet messages are:
    • {tweetTo} - The above tweetTo configuration.
    • {internetSpeed} - The above internetSpeed configuration.
    • {downloadResult} - The poor download speed you're getting.
    • {uploadResult} - The poor upload speed you're getting.
    • {fractionOfSpeed} - The (calculated) percentage of DL speed that you're getting compared to your ISP's advertised speed ({internetSpeed})

Threshold Example (remember to limit your messages to 240 characters or less!):

    "tweetThresholds": {
        "5": [
            "Hey {tweetTo} I'm paying for {internetSpeed} Mb/s but getting only {downloadResult} Mb/s?!? Shame.",
            "Oi! {tweetTo} $100+/month for {internetSpeed} Mb/s and I only get {downloadResult} Mb/s? How does that seem fair?"
        ],
        "12.5": [
            "Uhh {tweetTo} for $100+/month I expect better than {downloadResult} Mb/s when I'm paying for {internetSpeed} Mb/s. Fix your network!",
            "Hey {tweetTo} why am I only getting {downloadResult} Mb/s when I pay for {internetSpeed} Mb/s? $100+/month for this??"
        ],
        "25": [
            "Well {tweetTo} I guess {downloadResult} Mb/s is better than nothing, still not worth $100/mnth when I expect {internetSpeed}Mb/s"
        ]
    }

Logging can be done to CSV files, with a log file for ping results and speed test results.

CSV Logging config example:

"log": {
    "type": "csv",
    "files": {
        "ping": "pingresults.csv",
        "speed": "speedresults.csv",
        "chuck": "chucks.csv"
    }
}

Usage

python speedcomplainer.py

Or to run in the background:

python speedcomplainer.py > /dev/null &

Installation

pip install -r requirements.txt