Metadata-Version: 2.1
Name: port-eye
Version: 0.2.0
Summary: Simple CLI port scanner
Home-page: https://github.com/aHugues/port-eye.git
Author: Aurélien Hugues
Author-email: me@aurelienhugues.com
License: MIT
Description: # port-eye
        
        [![Build Status](https://travis-ci.org/aHugues/port-eye.svg?branch=master)](https://travis-ci.org/aHugues/port-eye)
        [![codecov](https://codecov.io/gh/aHugues/port-eye/branch/master/graph/badge.svg)](https://codecov.io/gh/aHugues/port-eye)
        [![code style](https://img.shields.io/badge/code_style-black-black)](https://github.com/psf/black)
        [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
        
        Simple CLI wrapper around nmap to perform port scanning in Python
        
        **Note:** This software is indended for legitimate use only.
        
        ## Features
        
        - Scanning of IPV4, IPV6 hosts and CIDR blocks.
        - Parsing of hosts from input file.
        - Automated generation of reports in HTML format.
        - Parallel scanning for increased performance.
        - Optional Docker-based execution.
        
        Example command:
        ```bash
        $ port-eye -h4 127.0.0.1 -o report.html
        ```
        
        Output html file example: 
        
        ![Example output](images/example_output.png)
        
        ## Installation
        
        This application is compatible with Python 2.7 and Python 3.5+.
        
        ### Docker installation
        
        If you have Docker installed, you can pull the image from Docker-Hub:
        
        ```bash
        docker pull ahugues/port-eye
        ````
        
        You can also build the image by cloning the repository and running: 
        
        ```bash
        docker build -t port-eye .
        ```
        
        
        ### Prerequisites
        
        You need to install `nmap` on your machine for the application to work (unless you choose the Docker install.)
        
        Example on Ubuntu: 
        
        ```bash
        sudo apt update
        sudo apt install nmap
        ```
        
        Example on Arch
        
        ```bash
        sudo pacman -S nmap
        ``` 
        
        Example on Mac with Homebrew
        
        ```bash
        brew install nmap
        ```
        
        ### Install with pypi
        
        If you have Python 2.7 or 3.5+ installed, you can install `port-eye` from PyPI:
        
        ```bash
        pip install port-eye
        ```
        
        or locally by clonning the repository and running:
        
        ```bash
        pip install .
        ```
        
        
        ## Usage
        
        ### General notes
        
        `port-eye` exposes a command line executable named `port-eye`
        
        When run without any option, `port-eye` will simply display the help message.
        
        Input hosts can be inputed from the CLI with the option `-t` or `-target`. Inputted hosts 
        can be IPV4 and 6 as well as CIDR blocks. 
        
        Hosts can be added from an input file in which hosts are put line by line. Example: 
        ```
        127.0.0.1
        ::1
        8.8.8.8
        ```
        
        If using Docker, and assuming you are working in a certain directory, you can run a `port-eye` container using:
        
        ```bash
        docker run -v "$(pwd)":/files port-eye <options>
        ```
        
        Or if built locally
        
        ```bash
        docker run -v "$(pwd)":/files port-eye <options>
        ```
        
        ### CLI reference
        
        ```
        Usage: port-eye [OPTIONS]
        
          Run the main application from arguments provided in the CLI.
        
        Options:
          -t, --target TEXT  Target host (IPV4, IPV6 or CIDR
          -f, --file PATH    File containing the hosts to check
          -o, --output PATH  Output HTML file into which the results must be stored
                             [required]
          -s, --sudo         Run nmap as privileged user for more accurate scanning
          -d, --debug        Display debug information to the terminal
          -m, --mock         Use mock API instead of really running nmap
          -h, --help         Show this message and exit.
        ```
        
        ## Contributing
        
        Contributions are closed at the moment.
        
        ## License
        
        MIT
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=2.7
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: dev
