Skip to content

v1.0.0

Latest
Latest

Choose a tag to compare

View all tags
@amnh30 amnh30 released this 28 Mar 01:06
· 22 commits to main since this release
v1.0.0
11ec6fe
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

PyNetScan v1.0.0 Release Notes

Release Date: March 27, 2025
Repository: github.com/amnh30/Pynetscan

Overview

PyNetScan is a Python-based network scanning tool leveraging nmap to discover and analyze devices on a local network. This initial release (v1.0.0) provides a robust foundation for network exploration with multiple scan modes and detailed output.

Features

  • Scan Modes:
    • Standard: Balanced scan with OS and service detection.
    • Quick: Fast ping scan for live hosts.
    • Detailed: Verbose scan with OS, service, and port details.
    • Custom Subnet: User-defined subnet scanning (e.g., /16, /24).
  • Output:
    • Tabulated device details: IP, MAC, vendor, hostname, OS, and open ports.
    • ASCII network topology map centered on the gateway.
    • Results saved to timestamped files (e.g., network_scan_standard_2025-03-27_20-00-00.txt).
  • Error Handling: Logs errors to files if scans fail (e.g., missing permissions).
  • UTF-8 Support: Ensures compatibility with special characters.

Installation

  1. Clone the Repository: 
    git clone https://github.com/yourusername/pynetscan.git
cd pynetscan
  2. Install Dependencies:
    • nmap: sudo apt-get install nmap (Linux), brew install nmap (macOS), or download from nmap.org.
    • Python packages: pip install python-nmap tabulate
  3. Run: 
    sudo python3 pynetscan.py

Usage

  • Launch the script and choose from the menu (1-6):
    • 1: Standard Scan
    • 2: Quick Scan
    • 3: Detailed Scan
    • 4: Custom Subnet Scan (e.g., /24)
    • 5: Help
    • 6: Exit
  • Results are displayed in the terminal and saved to a file.

Requirements

  • Python 3.x
  • nmap installed
  • Python packages: python-nmap, tabulate
  • Admin/root privileges recommended

Known Limitations

  • MAC addresses may not appear for devices behind routers or with firewalls.
  • Quick scans skip OS and port detection for speed.

Changelog

  • v1.0.0: Initial release with core scanning functionality, topology mapping, and file output.

Future Plans

  • Enhanced topology visualization.
  • Support for additional scan types (e.g., UDP scans).
  • GUI option for non-terminal users.

Contributing

Submit issues or pull requests at github.com/yourusername/pynetscan. See README.md for details.

License

Licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). See LICENSE for details.

Notes

  • License Reference: The AGPL-3.0 is mentioned with a link to the LICENSE file, which you should still create in your repository. You can copy the full text from gnu.org or use GitHub’s license template when setting up the repo (select "GNU Affero General Public License v3.0").
  • Usage: Add this as RELEASE.md or paste it into the GitHub release description for v1.0.0.

Let me know if you need further adjustments!

Assets 2
Loading