├── .gitignore
├── LICENSE
├── Pipfile
├── README.md
├── jiofi
    ├── __init__.py
    └── jiofi.py
├── requirements.txt
├── setup.cfg
└── setup.py


/.gitignore:
--------------------------------------------------------------------------------
 1 | .DS_Store
 2 | .idea/
 3 | __pycache__/
 4 | dist/
 5 | build/
 6 | *.egg-info
 7 | .cache/
 8 | .tox
 9 | .coverage
10 | *.pyc
11 | *.egg
12 | venv
13 | .eggs


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2020 ATHUL CYRIAC AJAY
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of
 6 | this software and associated documentation files (the "Software"), to deal in
 7 | the Software without restriction, including without limitation the rights to
 8 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 9 | the Software, and to permit persons to whom the Software is furnished to do so,
10 | subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18 | COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


--------------------------------------------------------------------------------
/Pipfile:
--------------------------------------------------------------------------------
 1 | [[source]]
 2 | name = "pypi"
 3 | url = "https://pypi.org/simple"
 4 | verify_ssl = true
 5 | 
 6 | [dev-packages]
 7 | 
 8 | [packages]
 9 | 
10 | [requires]
11 | python_version = "3.7"
12 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Jiofi CLI
 2 | 
 3 | Jiofi-CLI is a Command Line Interface to check your Jiofi Network from your terminal than using the web interface. It only shows very specific details like battery details, data usage and devices connected.
 4 | 
 5 | ## Tested on
 6 | 
 7 | - Jiofi4
 8 | 
 9 | > Open an Issue or PR to contribute to and the testing of other Models
10 | 
11 | ## Using it
12 | 
13 | Install `jiofi` with `pip`. It works on Python version >=3.6.
14 | 
15 | ```bash
16 | pip install jiofi --user
17 | ```
18 | 
19 | Once you installed it, run it by typing `jiofi` in your terminal.
20 | 
21 | ```
22 | $ jiofi
23 | ```
24 | You'll be welcomed by the help page of jiofi 😄
25 | 
26 | ```text
27 | NAME
28 |     jiofi
29 | 
30 | SYNOPSIS
31 |     jiofi COMMAND
32 | 
33 | COMMANDS
34 |     COMMAND is one of the following:
35 | 
36 |      devices
37 |        Prints a tabular view of all the connected devices in the network
38 | 
39 |      speed
40 |        Prints the Current upload and download speed
41 | 
42 |      basic
43 |        Get basic Details like Battery charge and state, no of connected devices and data used in <time>
44 | 
45 |      usage
46 |        Get Data usage in Upload and Download data in <time>
47 | 
48 |      device
49 |        Get Details of the device, Battery Charge, Battery State, Phone number or MSISDN
50 | ```
51 | 
52 | You can exit the help screen by pressing `q`(Vim Space)
53 | 
54 | ## Contributing
55 | 
56 | This is under [MIT License](/LICENSE). All Pull Requests are welcome. If you find a bug feel free to open an [Issue](https://github.com/athul/jiofi-cli/issues)
57 | 
58 | ### Made with
59 | 
60 | - Python
61 |   - `requests` for HTTP requests
62 |   - `fire` for CLI interface
63 |   - `rich` for Tables and Colors
64 | 


--------------------------------------------------------------------------------
/jiofi/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/athul/jiofi-cli/63403e2d1cedcc21b14681a7a9a97035f94a1099/jiofi/__init__.py


--------------------------------------------------------------------------------
/jiofi/jiofi.py:
--------------------------------------------------------------------------------
  1 | """
  2 | Jiofi-cli is a CLI for fetching data from your Jiofi network without going to Jiofi Web DashBoard.
  3 | 
  4 | :authors: Athul Cyriac Ajay <athul8720@gmail.com>
  5 | """
  6 | import requests
  7 | import sys
  8 | import fire
  9 | import socket
 10 | from urllib3.exceptions import NewConnectionError,MaxRetryError
 11 | from rich import print, text
 12 | from rich.table import Table
 13 | from rich.console import Console
 14 | 
 15 | URL = "http://jiofi.local.html/cgi-bin/qcmap_web_cgi"
 16 | 
 17 | 
 18 | def getDevices(log:bool = True):
 19 |     """Prints a tabular view of all the connected devices in the network
 20 |     """
 21 |     form = {'Page':'GetLANInfo'}
 22 |     try:
 23 |         res = requests.post(URL,form)
 24 |     except requests.ConnectionError or NewConnectionError or MaxRetryError or socket.gaierror as err:
 25 |         print("Connect to a Jiofi Network to get the details")
 26 |         exit(1)
 27 |     data = res.json()
 28 |     no_devices = data['client_count']
 29 |     devices = data['entries']
 30 |     if log is False:
 31 |         return no_devices
 32 |     else:
 33 |         table = Table(title=f"Devices Connected: {no_devices}")
 34 |         table.add_column("Name", justify="center", style="cyan", no_wrap=True)
 35 |         table.add_column("IPV4", justify="center", style="green",  no_wrap=True)
 36 |         table.add_column("IPV6", justify="center", style="magenta",    no_wrap=True)
 37 |         table.add_column("MAC", justify="center", style="pale_green1", no_wrap=True)
 38 |         table.add_column("Time", justify="center", style="orange3",    no_wrap=True)
 39 |         table.add_column("Status", justify="center", style="purple",   no_wrap=True)
 40 |         for i,l in enumerate(devices):
 41 |             table.add_row(devices[i]['name'],devices[i]['ipv4'],devices[i]['ipv6'],devices[i]['mac'],devices[i]['time'],devices[i]['status'])
 42 |         console = Console()
 43 |         console.print(table)
 44 | 
 45 | def getBandwidth():
 46 |     """Prints the Current upload and download speed
 47 |     """
 48 |     form = {'Page':'GetSystemPerformance'}
 49 |     try:
 50 |         res = requests.post(URL,form)
 51 |     except requests.ConnectionError:
 52 |         print("Connect to a Jiofi Network to get the details")
 53 |         sys.exit(1)
 54 |     data = res.json()
 55 |     curr_up = data['uplink_cur_usg']
 56 |     curr_down = data['dwlink_cur_usg']
 57 |     print(f"Current Upload Speed:\t[bold magenta]{curr_up} ↑[/bold magenta]\nCurrent Download Speed:\t[bold cyan]{curr_down} ↓[/bold cyan]")
 58 | 
 59 | 
 60 | def getLteStats():
 61 |     form = {'Page':'GetLTEStatus'}
 62 |     try:
 63 |         res = requests.post(URL,form)
 64 |     except requests.ConnectionError:
 65 |         print("Connect to a Jiofi Network to get the details")
 66 |         sys.exit(1)
 67 |     data = res.json()
 68 |     return (data['connection_time'],data['signal_strength'])
 69 | 
 70 | 
 71 | def deviceDetails(log:bool = True):
 72 |     """Get Details of the device, Battery Charge, Battery State, Phone number or MSISDN
 73 |     """
 74 |     form = {'Page':'GetDeviceDetails'}
 75 |     try:
 76 |         res = requests.post(URL,form)
 77 |     except requests.ConnectionError:
 78 |         print("Connect to a Jiofi Network to get the details")
 79 |         sys.exit(1)
 80 |     data = res.json()
 81 |     battery = data['battery_level']
 82 |     status = data['battery_status']
 83 |     if status == "Discharging":
 84 |         battery_status = f"[bold red]{status}[/bold red]"
 85 |     else:
 86 |         battery_status = f"[green]{status}[/green]"
 87 |     phone = data['msisdn']
 88 |     if int(battery) >= 50:
 89 |         battery = f"[sea_green2]{battery}%[/sea_green2]"
 90 |     else:
 91 |         battery = f"[turquoise2]{battery}%[/turquoise2]"
 92 |     if log is False:
 93 |         return battery,battery_status
 94 |     else:
 95 |         print(f"Battery:zap: :\t {battery}\nBattery Status:\t {battery_status}\nJio Number:\t{phone}\nConnection\t[yellow1]{getLteStats()[1]}[/yellow1]")
 96 | 
 97 | def getWanInfo(log:bool = True):
 98 |     """Get Data usage in Upload and Download data in <time>
 99 |     """
100 |     form = {'Page':'GetWANInfo'}
101 |     try:
102 |         res = requests.post(URL,form)
103 |     except requests.ConnectionError:
104 |         print("Connect to a Jiofi Network to get the details")
105 |         sys.exit(1)
106 |     data = res.json()
107 |     data_upl = data['total_data_used_ulink']
108 |     data_dwl = data['total_data_used_dlink']
109 |     usage = data['total_data_used']
110 |     total_data = f"[spring_green2]{float(usage)/1000000}[/spring_green2]"
111 |     if log is False:
112 |         return total_data
113 |     else:
114 |         print(f'Upload Data Usage:\t{data_upl}\nDownload Data Usage:\t{data_dwl}\nTotal Data Usage:\t{total_data} MB in [orange3]{getLteStats()[0]} Hours[/orange3]')
115 | 
116 | def getBasicDetails():
117 |     """Get basic Details like Battery charge and state, no of connected devices and data used in <time>
118 |     """
119 |     bats = deviceDetails(False)
120 |     devc = getDevices(False)
121 |     usg = getWanInfo(False)
122 |     time = getLteStats()
123 |     print(f'Battery:\t{bats[0]}%\nBattery Status:\t{bats[1]}\nNo of Users:\t{devc}\nData usage\t{usg} MB in {time[0]} \nSignal Strength: [bold yellow]{time[1]}[/bold yellow]')
124 | 
125 | def main():
126 |     fire.Fire({
127 |       'devices': getDevices,
128 |       'speed': getBandwidth,
129 |       'basic':getBasicDetails,
130 |       'usage':getWanInfo,
131 |       'device':deviceDetails
132 |   })
133 |     # getBandwidth()
134 |     # getBasicDetails()
135 |     # getDevices()
136 |     # getWanInfo()
137 |     # deviceDetails()
138 | if __name__ == '__main__':
139 |     main()
140 | 


--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
 1 | bleach==3.1.5
 2 | certifi==2020.6.20
 3 | chardet==3.0.4
 4 | colorama==0.4.3
 5 | commonmark==0.9.1
 6 | docutils==0.16
 7 | fire==0.3.1
 8 | idna==2.10
 9 | importlib-metadata==1.7.0
10 | keyring==21.2.1
11 | packaging==20.4
12 | pkginfo==1.5.0.1
13 | pprintpp==0.4.0
14 | Pygments==2.6.1
15 | pyparsing==2.4.7
16 | readme-renderer==26.0
17 | requests==2.24.0
18 | requests-toolbelt==0.9.1
19 | rfc3986==1.4.0
20 | rich==4.2.2
21 | six==1.15.0
22 | soupsieve==2.0.1
23 | termcolor==1.1.0
24 | tqdm==4.48.0
25 | twine==3.2.0
26 | typing-extensions==3.7.4.2
27 | urllib3==1.25.10
28 | webencodings==0.5.1
29 | zipp==3.1.0
30 | 


--------------------------------------------------------------------------------
/setup.cfg:
--------------------------------------------------------------------------------
1 | [metadata]
2 | description-file = README.md


--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
 1 | try:
 2 |     from setuptools import setup
 3 | except ImportError:
 4 |     from distutils.core import setup
 5 | 
 6 | 
 7 | with open('README.md') as f:
 8 |     readme = f.read()
 9 | 
10 | setup(
11 |     name='jiofi',
12 |     include_package_data=True,
13 |     packages=['jiofi',],
14 |     license='MIT',
15 |     python_requires='>=3.6.0',
16 |     install_requires= ['requests','fire', 'rich'],
17 |     entry_points = {"console_scripts": ['jiofi = jiofi.jiofi:main']},
18 |     url="https://github.com/athul/jiofi-cli",
19 |     author="Athul Cyriac Ajay",
20 |     author_email="athul8720@gmail.com",
21 |     description="A Command Line Interface to get stats about your Jiofi.",
22 |     long_description=readme,
23 |     version='0.1.3',
24 |     classifiers=[
25 |         'License :: OSI Approved :: MIT License',
26 |         'Programming Language :: Python :: 3.6'
27 |     ],
28 |     long_description_content_type='text/markdown',
29 | )


--------------------------------------------------------------------------------