Skip to content
Tutorial Reference

Python Network: How to Build a GUI Network Scanner with Nmap

Learn how to create a Python GUI network scanner using Nmap and Tkinter, with step-by-step code for scanning IPs and displaying results in a user-friendly interface.

Network scanning is a critical step in cybersecurity and network administration for discovering active devices and open ports. While nmap is a powerful command-line tool, building a Graphical User Interface (GUI) around it makes it more accessible and user-friendly.

This guide demonstrates how to create a Python application that accepts an IP address, executes an Nmap scan, and displays the results using tkinter for the GUI and subprocess to interact with the system.

Prerequisites and Installation

To build this scanner, you need Python installed, along with the nmap system utility. We will also use tkinter (usually included with Python) and subprocess (standard library).

Installing Nmap

You must have the underlying nmap tool installed on your operating system, not just the Python library.

sudo apt update
sudo apt-get install nmap -y
sudo apt-get install python3-tk -y

Handling the Nmap Process

The core logic involves receiving an IP address, running a shell command, and capturing the output.

The Scan Function

We need a function that runs nmap -F <ip> (Fast scan) and captures the standard output.

import subprocess

def basic_scan(ip_address):
    output = subprocess.check_output(["nmap", "-F", ip_address])
    return output.decode("utf-8")

To make this robust, we must handle exceptions, such as the user entering an invalid IP or Nmap failing to run.

import subprocess

def scan_network(ip_address):
    try:
        output = subprocess.check_output(["nmap", "-F", ip_address])
        return output.decode("utf-8")
    except subprocess.CalledProcessError:
        return "Error: Could not scan. Check IP address or Nmap installation."
    except FileNotFoundError:
        return "Error: Nmap is not installed or not in your PATH."

Building the GUI with Tkinter

We will construct a simple window with three main elements:

  1. Entry: For the user to type the IP.
  2. Button: To trigger the scan.
  3. Text: To display the multiline output.
import tkinter as tk

window = tk.Tk()
window.title("Network Scanner")

label_ip = tk.Label(window, text="Enter IP Address:")
label_ip.pack()

entry_ip = tk.Entry(window)
entry_ip.pack()

result_text = tk.Text(window, height=15, width=60)
result_text.pack()

Complete Source Code

Here is the fully functional code combining the logic and the interface.

Create a file named network_scanner.py:

import tkinter as tk
import subprocess

def run_scan():
    """
    Retrieves IP from entry, runs Nmap, and updates the text area.
    """
    ip_address = entry_ip.get()
    
    result_text.delete(1.0, tk.END)
    result_text.insert(tk.END, f"Scanning network: {ip_address}...\nPlease wait.\n\n")
    
    window.update()

    try:
        output = subprocess.check_output(["nmap", "-F", ip_address])
        
        result_text.insert(tk.END, output.decode("utf-8"))
        
    except subprocess.CalledProcessError:
        result_text.insert(tk.END, "⚠️ Error: The scan failed. Please check the IP address.")
    except FileNotFoundError:
        result_text.insert(tk.END, "⚠️ Error: 'nmap' command not found. Please install Nmap.")

window = tk.Tk()
window.title("Python Network Scanner")
window.geometry("500x400")

label_ip = tk.Label(window, text="Enter Target IP (e.g., 127.0.0.1):", font=("Arial", 12))
label_ip.pack(pady=10)

entry_ip = tk.Entry(window, font=("Arial", 12))
entry_ip.pack(pady=5)

scan_button = tk.Button(window, text="Scan Network", font=("Arial", 12, "bold"), command=run_scan)
scan_button.pack(pady=10)

result_text = tk.Text(window, font=("Consolas", 10), height=15)
result_text.pack(padx=10, pady=10, fill=tk.BOTH, expand=True)

window.mainloop()

Running the Project

python network_scanner.py
  1. The window appears.
  2. Enter an IP (e.g., 127.0.0.1 or google.com).
  3. Click Scan Network.

Output Example (in GUI):

Scanning network: 127.0.0.1...
Please wait.

Starting Nmap 7.80 ( https://nmap.org ) at 2025-12-20
Nmap scan report for localhost (127.0.0.1)
Host is up (0.000045s latency).
Not shown: 96 closed ports
PORT     STATE SERVICE
22/tcp   open  ssh
80/tcp   open  http
631/tcp  open  ipp
5432/tcp open  postgresql

Nmap done: 1 IP address (1 host up) scanned in 0.12 seconds

Conclusion

You have successfully built a GUI wrapper for a command-line tool.

  1. subprocess.check_output allows you to harness the power of system tools like Nmap within Python.
  2. tkinter provides a straightforward way to accept input and visualize the raw text output.
  3. Error Handling ensures the application reports issues (like missing dependencies) instead of crashing silently.
Navigation