https://github.com/hatixntsoa/port.scanner
A Simple Port Scanner Tool made with Python
https://github.com/hatixntsoa/port.scanner
port-scanner pypi python
Last synced: 6 months ago
JSON representation
A Simple Port Scanner Tool made with Python
- Host: GitHub
- URL: https://github.com/hatixntsoa/port.scanner
- Owner: hatixntsoa
- License: mit
- Created: 2024-09-22T15:45:34.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-08-29T05:39:41.000Z (11 months ago)
- Last Synced: 2025-11-27T17:38:28.903Z (8 months ago)
- Topics: port-scanner, pypi, python
- Language: Python
- Homepage: https://pypi.org/project/pyscan-tool
- Size: 405 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# PyScan Tool
``pyscan-tool`` is a Python-based port scanning utility that allows users to scan for open ports on a specified IP address. It provides options for scanning TCP and UDP ports, identifying services associated with each open port, and offering a command-line interface for ease of use.
### Contents
[Features](#features) |
[Installation](#installation) |
[Build from scratch](#option-2-build-from-source) |
[Usage](#usage) |
[Development](#development) |
[Contributing](#contributing)
## Features
- **Command-Line Interface (CLI)**: The default interface for scanning ports directly from the terminal.
- **Service Name Identification**: Automatically identifies and displays the service associated with each open port.
- **TCP and UDP Scanning**: Options to scan for both TCP and UDP ports.
- **Configurable Timeout**: Users can specify the timeout duration for connection attempts.
## Installation
### Option 1: Install from PyPI
To install `pyscan-tool` directly from PyPI:
```bash
pip install pyscan-tool
```
### Option 2: Build from Source
For those who prefer to build it themselves:
1. Clone the repository and navigate to the project directory:
```bash
git clone https://github.com/hatixntsoa/port.scanner.git
cd port.scanner
```
2. Build the package:
```bash
python setup.py sdist bdist_wheel
```
3. Install the package:
```bash
pip install dist/*.whl
```
## Usage
Once the package is installed, you can use the `pyscan` command from the terminal. The script accepts the following command-line arguments:
- **IP Address**:
- `-ip` or `--ip-address`: Specify the IP address to scan.
- **Port Range**:
- `-r` or `--range`: Specify the port range to scan (e.g., `80-443`).
- **Protocol**:
- `-p` or `--protocol`: Specify the protocol to use (`tcp` or `udp`). Default is `tcp`.
- **Timeout**:
- `-t` or `--timeout`: Specify the timeout duration in seconds. Default is `1.0`.
### Example Usage
1. **Basic Scan**:
```bash
pyscan -ip -r 80-443
```
2. **Specify Protocol and Timeout**:
```bash
pyscan -ip -r 1-100 -p udp -t 2
```
3. **Help Option**:
For help with command-line options, use:
```bash
pyscan -h
```
## Development
To modify or extend the functionality, ensure you have the required dependencies installed. You can add new features to the CLI as needed.
## Contributing
Feel free to fork this repository, open issues, or submit pull requests with improvements or bug fixes. Your contributions help make the `PyScan Tool` better!