Metadata-Version: 2.1
Name: star-scan
Version: 1.2
Summary: Simple port scanning module
Home-page: https://github.com/starhound/star_scan
Author: Wesley Reid
Author-email: wesleyreid0@gmail.com
License: MIT
Download-URL: https://github.com/starhound/star_scan/archive/main.zip
Keywords: NETWORK,UTILITY,PORT SCANNER
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown

# Star Scan
Module form of the 'Port Scan' utility

You can find the original utilities (Python file and CLI version) from [here](https://github.com/starhound/PortScan).

To utilize this package, do: *pip3 install star_scan*

**To scan a single client:**
```python3
import star_scan.scanner as scanner

ip_address = '127.0.0.1'
start_port = 1
end_port = 1000
scanner.scan_host(ip_address, start_port, end_port)
```

**or directly passing values**

```python
import star_scan.scanner as scanner

scanner.scan_host('127.0.0.1', 1, 1000)
```

**will produce similair results as:**

![Image of Results](https://i.imgur.com/73cgFzk.png)

**To scan a network:**
```python3
import star_scan.scanner as scanner 

#remove the last octet for scan_range()
ip_address = '192.168.1'
start_port = 1
end_port = 1000

#scans ports on all addresses from 192.168.1.1 to 192.168.1.255
scanner.scan_range(ip_address, start_port, end_port)
```

You can also directly pass values to scan_host()



