isimud 0.3__py3-none-any.whl

isimud/__init__.py

@@ -0,0 +1,12 @@
+#!/usr/bin/env python3
+
+from isimud.isimud import get_loopback_interface
+from isimud.isimud import get_eth_interfaces
+from isimud.isimud import get_wifi_interfaces
+from isimud.isimud import interface_operstate
+from isimud.isimud import interface_mac_address
+from isimud.isimud import interface_recv_bytes
+from isimud.isimud import interface_sent_bytes
+from isimud.isimud import access_point_essid
+from isimud.isimud import access_point_signal_percent
+from isimud.isimud import access_point_mac_address

isimud/isimud.py

@@ -0,0 +1,171 @@
+#!/usr/bin/env python3
+
+"""
+Package to get commonly used details of the network interface
+and access point you are using.
+"""
+
+from typing import Any, List, Optional
+
+from netifaces import interfaces
+
+from pyroute2 import IPRoute
+from pyroute2.iwutil import IW
+
+from subprocess import DEVNULL, PIPE, run
+
+from re import findall, search, I
+
+
+def get_loopback_interface() -> List[str]:
+    """ Return a list of loopback interfaces (ideally one). """
+    return [
+        interface for interface in interfaces(
+            ) if interface.startswith("lo")
+        ]
+
+
+def get_eth_interfaces() -> List[str]:
+    """ Return a list of ethernet interfaces (ideally one). """
+    return [
+        interface for interface in interfaces(
+            ) if interface.startswith("en")
+        ]
+
+
+def get_wifi_interfaces() -> List[str]:
+    """ Return list of wifi interfaces (ideally one). """
+    return [
+        interface for interface in interfaces(
+            ) if interface.startswith("wl")
+        ]
+
+
+def __get_iwconfig_output(interface: str) -> str:
+    """ Return iwconfig {interface} output. """
+    return run(
+            f"iwconfig {interface}",
+            shell=True,
+            stdout=PIPE,
+            stderr=DEVNULL
+        ).stdout.decode()
+
+
+def __winterface_name_to_device_dict(interface: str) -> Any:
+    """ Return a dict containing device details (from pyroute2.IW). """
+    with IW() as iw:
+        list_dev_dict = iw.list_dev()
+        for device_dict in list_dev_dict:
+            if device_dict["attrs"][1][1] == interface:
+                return device_dict
+    return None
+
+
+def __get_interface_number(interface: str) -> Optional[int]:
+    """ Return the interface number (from pyroute2.IPRoute). """
+    with IPRoute() as ipr:
+        interface_number_list = ipr.link_lookup(ifname=interface)
+        if len(interface_number_list) > 0:
+            return interface_number_list[0]
+    return None
+
+
+def __get_interface_stats(interface: str) -> Any:
+    """ Return the interface stats dict (from pyroute2.IPRoute). """
+    with IPRoute() as ipr:
+        return ipr.get_links(ifname=interface)[0]["attrs"][20][1]
+    return None
+
+
+def interface_operstate(interface: str) -> Optional[str]:
+    """
+    Get the operstate of an interface.
+
+    :param interface: str: Network interface.
+
+    """
+    interface_number = __get_interface_number(interface)
+    if interface_number:
+        with IPRoute() as ipr:
+            if interface_number in ipr.link_lookup(operstate="UP"):
+                return "UP"
+            elif interface_number in ipr.link_lookup(operstate="DOWN"):
+                return "DOWN"
+            elif interface_number in ipr.link_lookup(operstate="UNKNOWN"):
+                return "UNKNOWN"
+    return None
+
+
+def interface_mac_address(interface: str) -> str:
+    """
+    Get the MAC address of an interface.
+
+    :param interface: str: Network interface.
+
+    """
+    with IPRoute() as ipr:
+        return ipr.get_links(ifname=interface)[0]["attrs"][18][1]
+
+
+def interface_recv_bytes(interface: str) -> int:
+    """
+    Get the recv bytes of an interface.
+
+    :param interface: str: Network interface.
+
+    """
+    return __get_interface_stats(interface)["rx_bytes"]
+
+
+def interface_sent_bytes(interface: str) -> int:
+    """
+    Get the sent bytes of an interface.
+
+    :param interface: str: Network interface.
+
+    """
+    return __get_interface_stats(interface)["tx_bytes"]
+
+
+def access_point_essid(interface: str) -> Optional[str]:
+    """
+    Get the AP ESSID.
+
+    :param interface: str: Network interface.
+
+    """
+    device_dict = __winterface_name_to_device_dict(interface)
+    if device_dict:
+        if len(device_dict["attrs"]) >= 13:
+            if device_dict["attrs"][12][0] == "NL80211_ATTR_SSID":
+                return device_dict["attrs"][12][1]
+    return None
+
+
+def access_point_signal_percent(interface: str) -> Optional[int]:
+    """
+    Get the AP Signal percent.
+
+    :param interface: str: Network interface.
+
+    """
+    iwconfig_output = __get_iwconfig_output(interface)
+    res = findall(r"Link Quality=(\d*/\d*)", iwconfig_output)
+    if res != []:
+        signal = res[0].split("/")
+        return round(100 / int(signal[1]) * int(signal[0]))
+    return None
+
+
+def access_point_mac_address(interface: str) -> Optional[str]:
+    """
+    Get the AP MAC.
+
+    :param interface: str: Network interface.
+
+    """
+    iwconfig_output = __get_iwconfig_output(interface)
+    res = search(r'([0-9A-F]{2}[:-]){5}([0-9A-F]{2})', iwconfig_output, I)
+    if res:
+        return res.group().lower()
+    return None

isimud-0.3.dist-info/METADATA

@@ -0,0 +1,47 @@
+Metadata-Version: 2.4
+Name: isimud
+Version: 0.3
+Summary: Package to get commonly used details of the network interface and access points you are using.
+Author-email: "Carlos A. Planchón" <carlosandresplanchonprestes@gmail.com>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/carlosplanchon/isimud
+Keywords: isimud,sensors,wifi,networking
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: netifaces
+Requires-Dist: pyroute2
+Dynamic: license-file
+
+# Isimud
+*Package to get commonly used details of the network interface and access points you are using.*
+
+## Installation
+### Install with uv:
+```
+uv add isimud
+```
+
+## Features
+
+- Get loopback, ethernet and wifi interfaces.
+- Get operstate, mac_address, recv and sent bytes of an interface.
+- Get ESSID, signal percent and MAC address of an interface.
+
+## Usage
+```
+In [3]: import isimud
+
+In [4]: isimud.get_eth_interfaces()
+
+Out[4]: ['enp9s0']
+```

isimud-0.3.dist-info/RECORD

@@ -0,0 +1,7 @@
+isimud/__init__.py,sha256=TOwrQvRMYsfdLZubUpoFQ9YSYrKioRMI3xZuSxuuQ5o,502
+isimud/isimud.py,sha256=dL5yFmJaOfY6-mzqJWWmcj0oK66zuhaX0NHO1hFAolo,4573
+isimud-0.3.dist-info/licenses/LICENSE,sha256=dUqwRhq9nAYp-zfLbCuFB1d_dlg7PjxGZzNMPCTaa0c,1076
+isimud-0.3.dist-info/METADATA,sha256=DXGwQnS40yqdUCn_muc1hjnk6UjTFfg-j0yQ9BjILEM,1421
+isimud-0.3.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+isimud-0.3.dist-info/top_level.txt,sha256=2j2M-w531jC5zFjlZ0QVnCnzdsiKNCgvoOdmT2T5_xg,7
+isimud-0.3.dist-info/RECORD,,

isimud-0.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

isimud-0.3.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Carlos A. Planchón
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

isimud-0.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+isimud