Skip to content

Commit 582db02

Browse files
committed
Add Readme and License
1 parent 795e046 commit 582db02

File tree

3 files changed

+75
-0
lines changed

3 files changed

+75
-0
lines changed

LICENSE

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
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.

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
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+
6+
## Using it
7+
8+
- Clone this Repo
9+
- Install the Dependencies with `pip install -r requirements.txt`
10+
- Run the program `python main.py` . You'll be welcomed by the help section
11+
12+
```text
13+
NAME
14+
main.py
15+
16+
SYNOPSIS
17+
main.py COMMAND
18+
19+
COMMANDS
20+
COMMAND is one of the following:
21+
22+
devices
23+
Prints a tabular view of all the connected devices in the network
24+
25+
speed
26+
Prints the Current upload and download speed
27+
28+
basic
29+
Get basic Details like Battery charge and state, no of connected devices and data used in <time>
30+
31+
usage
32+
Get Data usage in Upload and Download data in <time>
33+
34+
device
35+
Get Details of the device, Battery Charge, Battery State, Phone number or MSISDN
36+
```
37+
38+
You can exit the help screen by pressing `q`(Vim Space)
39+
40+
## Contributing
41+
42+
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)
43+
44+
### Made with
45+
46+
- Python
47+
- `requests` for HTTP requests
48+
- `fire` for CLI interface
49+
50+
#### Tested on
51+
52+
- Jiofi4

requirements.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
certifi==2020.6.20
22
chardet==3.0.4
3+
fire==0.3.1
34
idna==2.10
45
requests==2.24.0
6+
six==1.15.0
57
soupsieve==2.0.1
68
tabulate==0.8.7
9+
termcolor==1.1.0
710
urllib3==1.25.10

0 commit comments

Comments
 (0)