Metadata-Version: 2.1
Name: who-is-on-my-wifi
Version: 1.3.3
Summary: Help you to find who is stealing your WiFI network, scan your WiFI and show you how many devices are currently connected!
Home-page: https://github.com/tucnakomet1/Python-Who-Is-On-My-WiFi
Author: Karel Velička
Author-email: tucnakomet@gmail.com
License: MIT
Description: <h1 align="center">Who is on my WiFi</h1>
        
        <p align="center"><img src="https://img.shields.io/github/stars/tucnakomet1/Python-Who-Is-On-My-WiFi?style=social" alt="GitHub Repo stars">
        <img src="https://img.shields.io/github/watchers/tucnakomet1/Python-Who-Is-On-My-WiFi?style=social" alt="GitHub watchers"> 
        <img src="https://img.shields.io/github/followers/tucnakomet1?style=social" alt="GitHub followers">
        <img src="https://img.shields.io/github/downloads/tucnakomet1/Python-Who-Is-On-My-WiFi/total?color=%23ff000&amp;logo=GitHub" alt="GitHub all releases">
        <img src="https://img.shields.io/github/v/release/tucnakomet1/Python-Who-Is-On-My-WiFi" alt="GitHub release (latest by date)">
        <img src="https://img.shields.io/github/repo-size/tucnakomet1/Python-Who-Is-On-My-WiFi" alt="GitHub repo size">
        <img src="https://img.shields.io/github/license/tucnakomet1/Python-Who-Is-On-My-WiFi" alt="GitHub"> 
        <img src="https://img.shields.io/github/languages/top/tucnakomet1/Python-Who-Is-On-My-WiFi" alt="GitHub top language"></p>
        
        <a href="https://github.com/tucnakomet1/Python-Who-Is-On-My-WiFi/blob/master/images/logo/logo.png"><img src="https://raw.githubusercontent.com/tucnakomet1/Python-Who-Is-On-My-WiFi/master/images/logo/logo_75x75.png" alt="info"  style="max-width:10%;" align="left" hspace="10"></a>Who-is-on-my-wifi is a Python3 cli project that allows you to see who is stealing your WiFI network, scan your WiFI and show you how many devices are connected. Software can be installed on any Windows and Linux device (Mac not verified).
        <h2></h2>
        
        <h2>Table of contents</h2>
        
        * <a href="#install">INSTALLATION</a><br/>
        	* <a href = "#pip">Pip</a><br/>
        	* <a href = "#deb">Debian based</a><br/>
        	* <a href = "#tar">Tarball/ Source</a><br/>
        * <a href = "#usage">USAGE</a><br/>
        	* <a href="#module">Command</a><br/>
        		* <a href = "#basicC">Basics</a><br/>
        		* <a href = "#whoC">How to see who is on my wifi?</a><br/>
        		* <a href = "#infoC">How to get information about my device?</a><br/>
        	* <a href="#python">Python3</a><br/>
        		* <a href = "#basicP">Basics</a><br/>
        		* <a href = "#whoP">How to see who is on my wifi?</a><br/>
        		* <a href = "#infoP">How to get information about my device?</a><br/>
        	* <a href = "#error">Error</a><br/>
        		* <a href = "#winpcap">WinPcapError:</a><br/>
        		* <a href = "#route">route: not found:</a><br/>
        * <a href = "#screen">SCREENSHOTS</a><br/>
        * <a href = "https://github.com/tucnakomet1/Python-Who-Is-On-My-WiFi/releases">RELEASES</a><br/>
        * <a href = "#survey">SURVEY</a></br>
        * <a href = "#todo">TO-DO LIST</a><br/>
        * <a href = "#license">LICENSE</a><br/>
        * <a href = "#contact">CONTACT</a><br/>
        <br/>
        
        <h2 id="install">INSTALLATION</h2>
        
        
        Windows need <a href="https://www.winpcap.org/install/">WinPcap</a>.<br/>
        <h3 id="pip">Pip</h3>
        
        `pip3 install who-is-on-my-wifi` <br/>
        
        <h3 id="deb">Debian based</h3>
        
        Download the latest deb for example from [release page](https://github.com/tucnakomet1/Python-Who-Is-On-My-WiFi/releases) and follow these commands.
        
        ```bash
        ### Download commands ###
        wget https://github.com/tucnakomet1/Python-Who-Is-On-My-WiFi/releases/download/1.3.3/who-is-on-my-wifi-v1.3.3.deb
        
        ### Install ###
        sudo dpkg -i who-is-on-my-wifi-v1.3.3.deb
        rm who-is-on-my-wifi-v1.3.3.deb #remove useless package
        
        ### Uninstall ###
        sudo dpkg -r who-is-on-my-wifi-v1.3.3
        ```
        
        <br/>
        
        <h3 id="tar">Tarball/ Source</h3>
        
        Download the latest tar [release](https://github.com/tucnakomet1/Python-Who-Is-On-My-WiFi/releases). Use any file manager or run command to extract package:
        
        ```bash
        ### Tarball ###
        tar -xvzf Python-Who-Is-On-My-WiFi*.tar.gz
        
        ### Zip ###
        unzip Python-Who-Is-On-My-WiFi*.zip
        
        ### Git ###
        git clone https://github.com/tucnakomet1/Python-Who-Is-On-My-WiFi.git
        
        ### Install ###
        cd Python-Who-Is-On-My-WiFi
        sudo chmod +x install
        ./install
        ```
        
        <br/><br/><br/>
        
        
        <h2 id="usage">USAGE</h2>
        
        Click for the expand... <br/><br/>
        <details>
        <summary>Command</summary>
        
        <h3 id="module"> Command </h3>
        
        <h4 id="basicC"> Basics </h4>
        
        ```
        usage: wiom [-h] [-v] [-c] [-d] [-w] [-t]
        
        Who-Is-On-My-WIFi
        
        optional arguments:
          -h, --help     show this help message and exit
          -v, --version  show current version
          -l, --license  show Open Source License
          -c, --contact  show contact
          -d, --device   show information about your device
          -w, --who      show who is on your WiFi!
          -t , --time    int supplement for '-w' command (scanning '-t' seconds)
        
        Thank you!
        ↓  ↓  ↓  ↓
        Visit my GitHub: https://github.com/tucnakomet1
        ```
        <br/>
        
        <h4 id="whoC"> How to see who is on my wifi? </h4>
        
        !!! You have to run this command as `sudo` or as `Administrator` !!!
        
        ```shell
        linux@name:~$ sudo wiom -w 			# default scanning time is 10 sec
        linux@name:~$ sudo wiom -w -t 5 		# scanning wifi for 5 sec
        ```
        
        <br/>
        
        <h4 id="infoC"> How to get information about my device? </h4>
        
        ```shell
        linux@name:~$ sudo wiom -d
        ```
        
        <br/>
        </details>
        <details>
        <summary>Python3</summary>
        <h3 id="python"> Python3 </h3>
        
        <h4 id="basicP"> Basics </h4>
        
        ```python3
        >>> import who_is_on_my_wifi as w
        >>>
        >>> who_is_on_my_wifi.help() # help page
        >>> who_is_on_my_wifi.license() # see license
        >>> who_is_on_my_wifi.contact() # contact page
        >>>
        >>> who_is_on_my_wifi.who(n) # see who is on my wifi (int('n') is scanning time - optional; default is 10)
        >>> who_is_on_my_wifi.device() # information about wifi and your device
        
        ```
        
        <h4 id="whoP"> How to see who is on my wifi? </h4>
        
        !!! You have to run this script as `sudo` or as `Administrator` !!!
        
        ```python
        from who_is_on_my_wifi import *
        
        WHO = who() # who(n)
        for j in range(0, len(WHO)):
        	comm = f"\n{WHO[j][0]} {WHO[j][1]}\n{WHO[j][2]} {WHO[j][3]}\n{WHO[j][4]} {WHO[j][5]}\n"
        	print(comm)
        
        # >>> OUTPUT <<<
        
        # IP Address: 192.168.0.1
        # Mac Address: 38:43:7d:62:42:24
        # Device: Compal Broadband Networks, Inc. (router)
        
        # IP Address: 192.168.0.24
        # Mac Address: 10:5b:ad:6c:64:55
        # Device: Mega Well Limited
        
        ...
        
        ```
        <br/>
        
        <h4 id="infoP"> How to get information about my device? </h4>
        
        ```python
        from who_is_on_my_wifi import *
        
        dev = device()
        
        print(f"""
        PC Name:            {dev[0]}
        PC Product-Name:    {dev[1]}
        MAC Address:        {dev[2]}
        IP Address (host):  {dev[3]}
        IP Address:         {dev[4]}
        Public IP:          {dev[5]}
        PC HostName:        {dev[6]}
        WiFi Name:          {dev[7]}
        Gateway:            {dev[8]}
        DNS 1:              {dev[9]}
        DNS 2:              {dev[10]}
        Password:           {dev[11]}
        Security:           {dev[12]}
        Interface:          {dev[13]}
        Frequency:          {dev[14]}
        Signal:             {dev[15]}
        Channel:            {dev[16]}
        
        
        Country:            {dev[17]}
        Region:             {dev[18]}
        City:               {dev[19]}
        Zip Code:           {dev[20]}
        Latitude:           {dev[21]}
        Longitude:          {dev[22]}
        ISP:                {dev[23]}
        """)
        
        
        # >>> OUTPUT <<<
        
        # PC Name:            ASUSTeK
        # PC Product-Name:    X521IA
        # MAC Address:        d8:c0:a6:a9:6a:6f
        # IP Address (host):  127.0.0.1
        ...
        
        
        
        ```
        <br/>
        </details>
        <details>
        <summary>Error</summary>
        <h3 id = "error"> Error </h3>
        
        <h4 id = "winpcap">RuntimeError: Sniffing and sending packets is not available at layer 2: winpcap is not installed </h4>
        
        This error means that you don't have ***WinPcap*** installed. <br/>
        To fix this you have to [download](https://www.winpcap.org/install/) it from their web page.
        <br/>
        
        <h4 id = "route">/bash/sh: 1: route: not found... </h4>
        
        This error means that you don't have ***net-tools*** installed. <br/>
        To fix this you have to download it using `sudo apt-get install net-tools`
        </details>
        
        <br/><br/><br/>
        
        <h2 id="screen">SCREENSHOTS</h2>
        
        ![device](https://raw.githubusercontent.com/tucnakomet1/Python-Who-Is-On-My-WiFi/master/images/screenshots/device_1_3.jpg)<br/>
        ![who](https://raw.githubusercontent.com/tucnakomet1/Python-Who-Is-On-My-WiFi/master/images/screenshots/who_1_3.jpg)<br/>
        <br/><br/><br/>
        
        <h2 id="survey"> SURVEY </h2>
        
        <p align="center" >Do you want to improve Who-Is-On-My-WiFi? Do you want to rate it? Or do you want to react for it?</p>
        <p align="center"><b>Fill out</b> this survey to help me <b>improve</b> this module!</p>
        
        [![survey](https://raw.githubusercontent.com/tucnakomet1/Python-Who-Is-On-My-WiFi/master/images/screenshots/survey.png "Who-Is-On-My-WiFi survey!")](http://www.survey-maker.com/Q4H2XR1KC)
        <br/><br/><br/>
        
        <h2 id="todo"> TO-DO LIST </h2>
        
        - [ ] Validated MacOS support (currently just experimental usage)
        - [ ] Add GUI
        - [ ] Add list of verified devices
        - [ ] Add WiFi Kill option
        
        <br/><br/><br/>
        
        
        <h2 id = "license"> LICENSE </h2>
        
        [MIT](https://github.com/tucnakomet1/Python-Who-Is-On-My-WiFi/blob/master/LICENSE.txt)
        <br/><br/><br/>
        
        <h2 id="contact">CONTACT</h2>
        You can contact me via my gmail address <a href="mailto:tucnakomet@gmail.com">tucnakomet@gmail.com</a>.<br/>
         <br/>
        
        If you like my project you can look at my [profile](https://github.com/tucnakomet1) or straight visit my next project [image-of-the-day](https://github.com/tucnakomet1/Image-Of-The-Day).
         
        
Platform: any
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
