Mediacom Data Usage Prediction (mdup) via SMS
This project is towards being able to receive via SMS your projected Mediacom internet usage and cost by leveraging Linear Regression and your email account (in this case I use gmail).
In order for this to work you will need to download the packages below. Specially for Selenium to work, you will need Chrome to be installed. That way the display could project properly.
This project has been tested on macOS and Ubuntu (server on docker).
How accurate is it? Well, nothing is really 100% accurate and I think it will depend on the methodology that you follow on how often you gather the data and the disclaimer from Mediacom "that recent usage may not be included in this amount due to routine or other delays in data usage aggregation and reporting." All of these variables will cause an effect on the prediction, but hey, is a lot better than not knowing how much data you will use by end of month.
In my case, I had an average of 98.5% of accuracy on my predictions, where some times it went over and other times under the predicted vs the usage.
Running the code in prod
To execute this program properly, you will need to have the following program installed on your environment.
- python >= 3.5 (I assume it will work on python 2.7 as well)
- Chrome >= 56
- ChromeDriver 2.30 (supports Chrome v58-60)
Tested on macOS and Ubuntu.
How to use it
Before you start anything there are some basic config that you will need to do. On the main project path, run the command below to create a config file. You will need to populate the variables to the right of the equal sign with your credentials.
echo 'isp_usr=YOUREMAIL@mediacombb.net isp_pwd=YOURPASSWORD gmail_usr=YOUREMAIL@gmail.com gmail_pwd=YOUR_GMAIL_PASSWORD' > conf
To run the main code you will need to make sure that you have your dev environment configured or build the docker image. The easier way is to build the docker image (note, this might take a while due to the packages to download and configure).
If you are using docker, then you can do the following. This will build, run, mount, and delete the docker container once done running. You can change
$(pwd) to an absolute path ->
/path/to/project/mdup to your local computer/host.
docker build -t blacknred0/mdup . docker run --rm -d -P \ -v $(pwd):/src/mdup \ blacknred0/mdup -g #just gather some data docker run --rm -d -P \ -v $(pwd):/src/mdup \ blacknred0/mdup -p email@example.com #predict
Not using docker built
If you are using your host (not docker), then you can do the following
python app.py -g firstname.lastname@example.org
Sending to more than one address.
python app.py -g email@example.com,firstname.lastname@example.org
To automate delivery of the SMS, than you can setup a crontab and send it every so often. In this case, it will run every 3 hours to gather data.
crontab -e 0 */3 * * * python /path/to/project/mdup/app.py -g 0 6,18 * * 2,4,6 python /path/to/project/mdup/app.py -p email@example.com > /dev/null 2>&1 #gather and email mediacom quota
Dev - Install packages & config env
These are the tools and configuration that you will need if you want to do testing on your side.
pip install numpy scipy matplotlib sympy nose pandas sklearn selenium pyvirtualdisplay
If you want to do your testing in Ubuntu (16.04 LTS), you will need to do the following.
sudo apt -y install wget python3 libxss1 libappindicator1 libindicator7 xvfb wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb sudo dpkg -i google-chrome*.deb sudo apt install -f -y #due to missing dependencies, then we will force and install them sudo dpkg -i google-chrome*.deb sudo ln /usr/bin/python3.5 /usr/bin/python wget https://bootstrap.pypa.io/get-pip.py python get-pip.py
Once you run
python get.pip.py, then you can go to step 2 from above by setting up "Python environment".
Docker way (using Ubuntu)
docker build -t blacknred0/mdup .
Download and configure your docker image.
#download & conf docker docker pull ubuntu #by default it will use latest LTS docker run -it ubuntu apt update #install dependencies, chrome, and config environment apt -y install wget python3 libxss1 libappindicator1 libindicator7 xvfb wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb dpkg -i google-chrome*.deb apt install -f -y #might be needed due to missing dependencies, then we will force and install them dpkg -i google-chrome*.deb ln /usr/bin/python3.5 /usr/bin/python wget https://bootstrap.pypa.io/get-pip.py python get-pip.py pip install numpy scipy matplotlib sympy nose pandas sklearn selenium pyvirtualdisplay rm google-chrome*.deb get.pip.py exit
Now, that you have your image ready, let's commit. Make sure that you replace "5d2c74af649f" with your docker image id.
docker commit -m "Configure the whole environment to run" -a "First Last Names" 5d2c74af649f blacknred0/mdup
Building docker image
All files and programs are ready for prime time. Make sure that you are on the main path location of the project and run the following to build your docker image.
docker build -t blacknred0/mdup .
This will run, mount, and delete the docker container once done running.
docker run --rm -d -P --volume /path/to/project/mdup:/src/mdup blacknred0/mdup firstname.lastname@example.org
To view the image with removing the docker container once you are done.
docker run --rm -it --entrypoint /bin/bash --volume /path/to/project/mdup:/src/mdup blacknred0/mdup
Below is the mapping table of the most common United States carriers and their gateway domain. You will need to place in front of the @ sign your ten digit phone number to where you are sending the message to.
For example, if my phone number is 555-777-9999 and I use Verizon, then I will be sending a SMS to