Metadata-Version: 2.1
Name: IPregexo
Version: 0.0.2
Summary: Validating and classifying IPv4 address
Home-page: https://github.com/omarthe95/IPregexo
Author: Omar Adil
Author-email: xomaradilxa@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown

# IPregex
Validating and Classifying IPv4 Address


### Prerequisites:

* Linux OS 
* Python >=3.5 "pre-installed"
```
python3 --version
```


* Python pip3 "If not installed feel free to surf the web for installation guide based on your OS"
```
pip3 --version
```

### Installing:

* Download and install IPregexo python package
```
pip3 install IPregexo
```
Take care PyPi packages name are case sensitive

* Import IPrexego on every python script you want to use it on
```
from IPregexo import IPregexo
```

### Examples:
* 1. Check vaild IP format and print **message** if so.
<img src="https://github.com/omarthe95/Resources/blob/master/IPregexo/check_IP_message_1.PNG">
<img src="https://github.com/omarthe95/Resources/blob/master/IPregexo/check_IP_message_2.PNG">

* 2. Check vaild IP format and return **Boolean** result if so.
<img src="https://github.com/omarthe95/Resources/blob/master/IPregexo/check_IP_Boolean_1.PNG">
<img src="https://github.com/omarthe95/Resources/blob/master/IPregexo/check_IP_Boolean_2.PNG">


### Commands:
| Command | Description |
| --- | --- |
| `check_IP` | Vaildate IP *format* and print **Message** |
| `checkB_IP` | Vaildate IP *format* and return **Boolean** |
| `check_IP_Private` | Vaildate if *Private IP* and print **Message** |
| `checkB_IP_Private` | Vaildate if *Private IP* and return **Boolean** |
| `check_IP_Private_A` | Vaildate if *Private IP Class A* and print **Message** |
| `checkB_IP_Private_A` | Vaildate if *Private IP Class A* and return **Boolean** |
| `check_IP_Private_B` | Vaildate if *Private IP Class B* and print **Message** |
| `checkB_IP_Private_B` | Vaildate if *Private IP Class B* and return **Boolean** |
| `check_IP_Private_C` | Vaildate if *Private IP Class C* and print **Message** |
| `checkB_IP_Private_C` | Vaildate if *Private IP Class C* and return **Boolean** |

## Authors

* **Omar Adil** - *Network Engineer* - [Linkedin](https://www.linkedin.com/in/OmarAdil)



## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details


