Metadata-Version: 2.1
Name: portscan
Version: 0.3.1
Summary: Simple port scanning utility at terminal
Home-page: https://github.com/Aperocky/PortScan
Author: Rocky Li
Author-email: aperocky@gmail.com
License: MIT
Description: # PortScan
        
        ![PyPI version](http://img.shields.io/pypi/v/portscan.svg) &nbsp; ![Python 3.x](http://img.shields.io/badge/Python-3.x-green.svg) &nbsp; ![PyPI license](https://img.shields.io/github/license/mashape/apistatus.svg) &nbsp; [![Downloads](https://pepy.tech/badge/portscan)](https://pepy.tech/project/portscan)
        
        PortScan is a *light-weight* command line utility that allows user to conduct scanning over a range of IP addresses and port ranges with multi-threading.
        
        Install: `pip install portscan`
        
        Upgrade: `pip install portscan --upgrade`
        
        Usage: `portscan [192.168.1.0/24] [-p 22,80-200 [-t 100 [-w 1 [-e]]]]`
        
        *New in version 0.2.1:*
        
        ![Simple Command](/images/Demo_3.png)
        
        By default the command checks for your *Local Area Network* IP first, and then initiate a block wise search. specify IP if you want to search any other IP blocks. *Note: This is not available before 0.2.1, please update or specify IP if you're using 0.2.0 and older*
        
        Use `-w [float]` to change timeout settings from default of `3` seconds: for LAN, this can be as low as `0.1`. `1` is usually good enough for continental level connection.
        
        ![Fast scanning](/images/Demo_2.png)
        *Scanned 5000 ports in 2 seconds*
        
        To show more potential connection, use `-e`, this will show you all ports that are not timed out.
        
        ![Show more potential connection](/images/Demo_1.png)
        
        ### Arguments
        
        `ip`: default and optional *(since 0.2.1, required before 0.2.1)* argument, can parse single IP, list of IP, IP blocks:
        
            192.168.1.0 # single IP
        
            192.168.1.0/24 # A 24 block, from 192.168.1.0 to 192.168.1.255
        
            [192.168.1.0/24,8.8.8.8] # The aforementioned 24 block and 8.8.8.8.
        
            "[192.168.1.0/24, 8.8.8.8]" # if you want to use space in the command, wrap in quotes.
        
        Options:
        
        `-p`, `--port`: port range, default `22,23,80`, use `,` as a delimiter without space, support port range (e.g. `22-100,5000`).
        
        `-t`, `--threadnum`: thread numbers, default 500, as of now, thread number have a hard cap of 2048. More thread will increase performance on large scale scans.
        
        `-e`, `--show_refused`: show connection errors other than timeouts, e.g. connection refused, permission denied with errno number as they happen.
        
        `-w`, `--wait`: Wait time for socket to respond. If scanning LAN or relatively fast internet connection, this can be set to `1` or even `0.2` for faster scanning. Default `3` seconds
        
        ## Acknowledgement
        
        Jamieson Becker: For coming up with a way to find local IP on stackoverflow, which I used: https://stackoverflow.com/questions/166506/finding-local-ip-addresses-using-pythons-stdlib
        
Keywords: port,scanner,multithreading,queue,terminal,utility
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
