mini-scanner
A lightweight, fast, and extensible TCP port scanner written in Python.
Features
- Fast multithreaded TCP port scanning
- Configurable connection timeout
- Banner grabbing
- JSON and text output
- Modular architecture
- Easy Python API
- Command-line interface
- Docker support
- Comprehensive test suite
- GitHub Actions CI/CD
Installation
pip install mini-scanner
Or install from source:
git clone https://github.com/Rohit30Confluence/mini-scanner.git
cd mini-scanner
pip install -e .
Quick Example
Scan common ports:
mini-scanner example.com
Scan specific ports:
mini-scanner example.com --ports 22,80,443
Save results:
mini-scanner example.com --output results.json --format json
Python API
from mini_scanner import Scanner
scanner = Scanner()
results = scanner.scan(
host="scanme.nmap.org",
ports=[22,80,443],
)
for result in results:
print(result)
Project Structure
mini-scanner/
├── mini_scanner/
├── tests/
├── docs/
├── .github/
├── Dockerfile
├── docker-compose.yml
├── pyproject.toml
└── README.md
Documentation
- Installation
- Quick Start
- CLI Reference
- API Reference
- Examples
- Development Guide
- Security Policy
Development
Run tests:
pytest
Run formatting:
make format
Run linting:
make lint
Run all quality checks:
make check
Contributing
Contributions are welcome.
Please read the Contributing Guide before opening an issue or pull request.
License
This project is licensed under the MIT License.
See the LICENSE file for details.