From 2f42f32a029e0a356b8b001c83713465b13c05b6 Mon Sep 17 00:00:00 2001 From: Emmanuel HC Date: Wed, 8 Jul 2026 11:54:30 -0500 Subject: [PATCH] Updated README.md file --- README.md | 26 +++++++++++++++++++++----- devices.csv | 10 +++++----- 2 files changed, 26 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 05a4ac5..5192bfc 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Network Connection Tester (v1.0.0) -Developed by Emmanuel Hernandez | Automation Engineering +Developed by Emmanuel Hernandez | Automation Specialist II A high-performance CLI tool designed to monitor network devices in real-time using parallel processing (up to 30 workers). It verifies ICMP reachability (Ping) and TCP port status, exporting a historical log to a timestamped CSV on exit. @@ -8,8 +8,24 @@ A high-performance CLI tool designed to monitor network devices in real-time usi * `devices_example.csv`: Template file for targets input. ## How to Run -1. Ensure you have Python installed and your virtual environment active. -2. Install dependencies: `pip install -r requirements.txt` -3. Execute the tool providing your CSV file: +1. Download the latest version from the **Releases** section. +2. Use `devices_example.csv` as a template to create a list of devices to be tested. +3. Using **File Explorer**, drag and drop your CSV file onto `Network_Scanner.exe` to execute the tool. +4. Once the tool opens, you will see a live table updating the status of your devices in real-time. +5. Press `Ctrl + C` to stop the execution and automatically generate the results report. +6. Press `Enter` to close the window. + +## How to Run .exe from Terminal +1. Navigate to the folder where the `Network_Scanner.exe` and the CSV files are located. +2. Run the file ```bash - python src/cli.py devices_example.csv \ No newline at end of file + python cli.py csv_file_name.csv + +## How to Run from Terminal (Development) +1. Ensure you have Python installed and your virtual environment active. +2. Install the required dependencies: + ```bash + pip install -r requirements.txt +3. Execute the tool by providing your target CSV file: + ```Bash + python src/cli.py csv_file_name.csv \ No newline at end of file diff --git a/devices.csv b/devices.csv index 8e88438..24300d4 100644 --- a/devices.csv +++ b/devices.csv @@ -1,5 +1,5 @@ -name,enabled,hostname,port,reverseWordOrder,zeroBasedAddressing -Test,false,192.168.1.81,502,true,true -Test2,true,192.168.1.82,502,false,false -Test3,false,192.168.1.83,502,true,true -Test3r,false,192.168.1.84,502,true,true +name,hostname,port +Test1,192.168.1.81,502 +Test2,192.168.1.82,502 +Test3,192.168.1.83,502 +Test4,192.168.1.84,502 \ No newline at end of file