woninet 2.0.1__tar.gz → 2.0.3__tar.gz

{woninet-2.0.1 → woninet-2.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: woninet
-Version: 2.0.1
+Version: 2.0.3
 Summary: A Python-based ARP+ICMP network monitoring tool
 Author-email: Alireza Teymuri <teymuri.alireza98@gmail.com>
 License-Expression: MIT
@@ -67,7 +67,36 @@ IPs and filters out Wi‑Fi ARP‑delay noise.)
 
 **Note:** *woninet* is under active development.
 
-## Installation
+## Installation from PyPI
+
+### Unix/Linux
+
+Create and activate a virtual environment:
+
+```shell
+python3 -m venv --copies venv
+source venv/bin/activate
+```
+
+Install woninet from PyPI:
+
+```shell
+pip install woninet
+```
+
+Grant the required capability to the Python interpreter:
+
+```shell
+sudo setcap cap_net_raw=eip venv/bin/python3
+```
+
+Then run:
+
+```shell
+woninet --help
+```
+
+#### macOS/Windows
 
 Install from PyPI:
 

{woninet-2.0.1 → woninet-2.0.3}/README.md

@@ -40,7 +40,36 @@ IPs and filters out Wi‑Fi ARP‑delay noise.)
 
 **Note:** *woninet* is under active development.
 
-## Installation
+## Installation from PyPI
+
+### Unix/Linux
+
+Create and activate a virtual environment:
+
+```shell
+python3 -m venv --copies venv
+source venv/bin/activate
+```
+
+Install woninet from PyPI:
+
+```shell
+pip install woninet
+```
+
+Grant the required capability to the Python interpreter:
+
+```shell
+sudo setcap cap_net_raw=eip venv/bin/python3
+```
+
+Then run:
+
+```shell
+woninet --help
+```
+
+#### macOS/Windows
 
 Install from PyPI:
 

{woninet-2.0.1 → woninet-2.0.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "woninet"
-version = "2.0.1"
+version = "2.0.3"
 description = "A Python-based ARP+ICMP network monitoring tool"
 readme = "README.md"
 requires-python = ">=3.12"

{woninet-2.0.1 → woninet-2.0.3}/woninet/__init__.py

@@ -1,2 +1,2 @@
 # woninet/core/__init__.py
-__version__ = "2.0.1"
+__version__ = "2.0.3"

{woninet-2.0.1 → woninet-2.0.3}/woninet/core/engine.py

@@ -292,7 +292,7 @@ class NetworkMonitorCore:
             ValueError: If IP addresses are not valid.
         """
         candidate_devices = {}
-        if target_ip_list is not None:
+        if len(target_ip_list) != 0:
             for target_ip in target_ip_list:
                 if detect_ip_range(ip=target_ip):
                     candidate_devices.update(

{woninet-2.0.1 → woninet-2.0.3}/woninet/core/graph.py

@@ -1,3 +1,4 @@
+import os
 from pathlib import Path
 from matplotlib import pyplot as plt
 from woninet.database.tables import AlertEventTable
@@ -9,6 +10,8 @@ class GraphEngine:
     """
     Engine for generating graphs and visualizations of network device metrics.
     """
+    def __init__(self):
+        os.makedirs(name=CHARTS_PATH, exist_ok=True)
 
     def design_device_latency_events(
         self, ip: str, recent_device_alert_events: list[AlertEventTable]

{woninet-2.0.1 → woninet-2.0.3}/woninet/main.py

@@ -9,10 +9,10 @@ from sqlalchemy.exc import OperationalError
 from woninet.core.engine import NetworkMonitorCore
 from woninet.utilities.arguments import args
 from woninet.utilities.logger import get_core_logger, TRACE_LEVEL
+from woninet.utilities.create_configuration import create_config_json
 
 # Global Variables
 LOGGING_YAML_PATH = Path(__file__).parent / "logging.yaml"
-CONFIG_JSON_PATH = Path(__file__).parent / "config.json"
 REMOTE_PROBE_IP = "8.8.8.8"
 monitor = None
 
@@ -67,13 +67,29 @@ def load_logging_yaml(log_output: str | None) -> dict:
     return config
 
 
-def load_config_json() -> dict:
+def load_config_json(config_json_path: str) -> dict:
+    """
+    Load the application's JSON configuration file.
+
+    If the configuration file does not exist, create a default one and
+    load it again.
+
+    Args:
+        config_json_path (str): Path to the configuration JSON file.
+
+    Returns:
+        dict: Parsed configuration data.
+    """
     try:
-        with open(CONFIG_JSON_PATH) as file:
+        with open(config_json_path) as file:
             config = json.load(file)
         return config
     except FileNotFoundError:
-        raise
+        create_config_json(config_json_path)
+
+        with open(config_json_path) as file:
+            config = json.load(file)
+        return config
 
 
 def configure_logger(arguments: Namespace) -> logging.Logger:
@@ -178,7 +194,8 @@ def main() -> None:
         print(__version__)
         return
 
-    configuration = load_config_json()
+    config_json_path = arguments.config
+    configuration = load_config_json(config_json_path)
 
     target_ip = configuration["target_ip_list"]
     port = arguments.port

{woninet-2.0.1 → woninet-2.0.3}/woninet/utilities/arguments.py

@@ -71,6 +71,13 @@ are collected continuously and processed through an alert engine."""
         help="Output path for storing logs.",
     )
 
+    parser.add_argument(
+        "--config",
+        type=str,
+        default="config.json",
+        help="Path to the config.json file to load (default: %(default)s).",
+    )
+
     parser.add_argument(
         "--color",
         type=str,

woninet-2.0.3/woninet/utilities/create_configuration.py

@@ -0,0 +1,36 @@
+import json
+
+
+def create_config_json(config_json_path: str) -> None:
+    """
+    Create a default configuration JSON file.
+
+    Args:
+        config_json_path: Path where the configuration JSON will be written.
+
+    The function writes a default configuration template containing monitoring
+    settings, database file name, target IP list, and alert rules.
+    """
+    template = {
+        "monitoring": {
+            "arp_noise_limit": 300.0,
+            "max_workers": 4
+        },
+        "database": "woninet.db",
+        "target_ip_list": [],
+        "alert_rules":[
+            {
+                "metric": "latency",
+                "threshold": 100,
+                "consecutive_checks": 3
+            },
+            {
+                "metric": "packet_loss",
+                "threshold": 0.0,
+                "consecutive_checks": 1
+            }
+        ]
+    }
+
+    with open(config_json_path, "w") as file:
+        json.dump(template, file, indent=4)

{woninet-2.0.1 → woninet-2.0.3}/woninet.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: woninet
-Version: 2.0.1
+Version: 2.0.3
 Summary: A Python-based ARP+ICMP network monitoring tool
 Author-email: Alireza Teymuri <teymuri.alireza98@gmail.com>
 License-Expression: MIT
@@ -67,7 +67,36 @@ IPs and filters out Wi‑Fi ARP‑delay noise.)
 
 **Note:** *woninet* is under active development.
 
-## Installation
+## Installation from PyPI
+
+### Unix/Linux
+
+Create and activate a virtual environment:
+
+```shell
+python3 -m venv --copies venv
+source venv/bin/activate
+```
+
+Install woninet from PyPI:
+
+```shell
+pip install woninet
+```
+
+Grant the required capability to the Python interpreter:
+
+```shell
+sudo setcap cap_net_raw=eip venv/bin/python3
+```
+
+Then run:
+
+```shell
+woninet --help
+```
+
+#### macOS/Windows
 
 Install from PyPI:
 

{woninet-2.0.1 → woninet-2.0.3}/woninet.egg-info/SOURCES.txt

@@ -55,6 +55,7 @@ woninet/server/templates/device_info.html
 woninet/utilities/__init__.py
 woninet/utilities/arguments.py
 woninet/utilities/cli_parser.py
+woninet/utilities/create_configuration.py
 woninet/utilities/detect_ip_range.py
 woninet/utilities/ip_validator.py
 woninet/utilities/logger.py