Documentation

README.md

@@ -1,6 +1,6 @@
 # PhoneInfoga
 
-Information gathering tool for phone numbers.
+Advanced information gathering tool for phone numbers.
 
 **This tool requires python 2.x**
 
@@ -8,14 +8,46 @@ Information gathering tool for phone numbers.
 
 - Check if phone number exists
 - Gather standard informations such as country, line type and carrier
-
-##### Up coming
 - Check several numbers at once
 - Set an output for result(s)
 - Check if number is from a VoIP provider
-- Get informations for special numbers (emergency)
+- Get informations about special numbers
 - Phone book search
 
+## Formats
+
+The tool only accepts E164 and International formats as input.
+
+- E164: +3396360XXXX
+- International: +33 9 63 60 XX XX
+- National: 09 63 60 XX XX
+- RFC3966: tel:+33-9-63-60-XX-XX
+- Out-of-country format from US: 011 33 9 63 60 XX XX
+
+## Number format by countries
+
+#### Europe
+
+- Belgium : 9 digits for land lines and 10 for mobile
+- Denmark : 8 digits
+- Germany : 10 digits
+- Greece : 10 digits
+- Hungary : 10 digits
+- Iceland : 10 digits
+- Ireland : 10 digits
+- Italy : 10 digits
+- Netherlands : 10 digits
+- Norway : 10 digits
+- Hungary : 10 digits
+
+## Available scanners
+
+- ovh
+- annu
+- numverify
+- any
+- all
+
 ## Installation
 
 ```bash
@@ -25,21 +57,48 @@ pip install -r requirements.txt
 python phoneinfoga.py -h
 ```
 
+Then set APIs credentials in `secrets.py`.
+
 ## Usage
 
 ```
 Usage: PhoneInfoga options 
 
        -n|--number: Phone number to search
+       -i|--input: Phone number to search
+       -o|--output: Phone number to search
+       -s|--scanner: Only use a specific scanner
        -h|--help: Help command
+       --update: Update the tool & databases
 ```
 
 Example :
 
+```python
+python phoneinfoga.py -n 0428375448
 ```
-python phoneinfoga.py -n 447700900409
+
+Check several numbers at once :
+
+```python
+python phoneinfoga.py -i numbers.txt -o results.txt
+```
+
+Check for a number range on OVH (just put some zeros) :
+
+```python
+python phoneinfoga.py -n 0428370000 -s ovh
 ```
 
 ## License
 
 This tool is MIT licensed.
+
+## Resources
+
+Regular expression : `^[+]*[(]{0,1}[0-9]{1,4}[)]{0,1}[-\s\./0-9]*$`
+
+- https://api.ovh.com/console/#/telephony
+- https://countrycode.org/
+- http://www.countryareacode.net/en/
+- http://whitepages.fr/phonesystem/