diff --git a/README.md b/README.md index 0b91470..e3a08ed 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,12 @@ +# bgc_add_vol_pack.py -![mesScripts](https://sirenacorp.be/wp-content/uploads/2016/01/logo-1.png) +The unlimited volume from Belgacom/Proximus is, in fact, limited. And when this limit is reached, your connection is nearly useless because its very low speed. -bgc_add_vol_pack.py -=== +This script help you to easily add extra volume packs, with a headless mode to use it in a monthly cron by example. -The unlimited volume of Belgacom/Proximus is, in fact, limited. And when this limit is reached, your connection is nearly useless because the very low speed of it. +## Parameters -This script help to easily add extra volume packs, with a headless mode to use it in a monthly cron by example. - -Parameters -=== - -``` +```shell usage: bgc_add_vol_pack.py [-h] [--repeat REPEAT] [--packSize PACKSIZE] [--headless HEADLESS] login password @@ -28,65 +23,59 @@ optional arguments: --packSize PACKSIZE Volume size of the pack to add (150 GB by default) --headless HEADLESS Headless mode (enabled by default ; using xvfb) ``` -Requirements -=== + +## Requirements This script is using the following Python 3 modules : -* argparse -```sudo pip3 install argparse``` -* selenium -```sudo pip3 install selenium``` -* pyvirtualdisplay -```sudo pip3 install pyvirtualdisplay``` +- `argparse` +- `selenium` +- `pyvirtualdisplay` -And the following cmdline tool (headless mode) : +And the following cmdline tool (headless mode) : -* xvfb (Ubuntu and derivatives) -```sudo apt-get install xvfb``` +- xvfb (Ubuntu and derivatives) : `sudo apt-get install xvfb` -Examples of use -=== +## Examples of use Add 1 pack of 150 GB (which are default values) -``` + +```shell ./bgc_add_vol_pack.py my_login my_password ``` Add 3 packs of 150 GB in headless mode -``` + +```shell ./bgc_add_vol_pack.py my_login my_password --repeat 3 --packSize 150 ``` Add 10 packs of 20 GB in headless mode disable (FireFox will be opened) -``` + +```shell ./bgc_add_vol_pack.py my_login my_password --repeat 10 --packSize 20 --headless 0 ``` -Credits -=== +## Credits -These scripts have been modified and improved by Francois B. (Makotosan / Shakasan) based on the initial script written by Tuxicoman (see Initial Credits And Licence below) +These scripts have been modified and improved by Francois B. (Makoto) based on the initial script written by Tuxicoman (see Initial Credits And Licence below) -* Email : shakasan [at] sirenacorp.be -* Website : [Makoto no Blog](https://sirenacorp.be/) +- Website : [Makoto no Blog](https://makotonoblog.be/) -Initial Credits and Licence -=== +## Initial Credits and Licence -Copyright (C) 2016 Tuxicoman +Copyright (C) 2016 Tuxicoman This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later $ This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more detail$ -You should have received a copy of the GNU Affero General Public License along with this program. If not, see . +You should have received a copy of the GNU Affero General Public License along with this program. If not, see . -Link to the post on Tuxicoman website : https://tuxicoman.jesuislibre.net/2016/05/internet-vraiment-illimite-chez-belgacomproximus.html +Link to the post on Tuxicoman website : -Improvements - Changelog -=== +## Improvements - Changelog -* Updated for Python3 -* Any volume pack sizes -* WebDriverWait increased up to 20 to *try* to avoid login failures -* Headless mode added as optional parameter -* repeat and packSize parameters are optional with default value to 1 pack of 150 GB +- Updated for Python3 +- Any volume pack sizes +- WebDriverWait increased up to 20 to _try_ to avoid login failures +- Headless mode added as optional parameter +- repeat and packSize parameters are optional with default value to 1 pack of 150 GB