pyhw 0.1.3b0__tar.gz → 0.7.3__tar.gz

pyhw-0.7.3/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.2
+Name: pyhw
+Version: 0.7.3
+Summary: PyHw, a neofetch-like command line tool for fetching system information but written mostly in python.
+Author-email: Xiao Ran <xiaoran.007@icloud.com>
+License: BSD-3-Clause
+Project-URL: homepage, https://github.com/xiaoran007/pyhw
+Keywords: neofetch,system information,command line tool,python,hardware information,fastfetch,fetching
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pypci-ng>=0.0.10
+
+# PyHw
+[![Downloads](https://static.pepy.tech/badge/pyhw)](https://pepy.tech/project/pyhw)
+![PyPI - Version](https://img.shields.io/pypi/v/pyhw?label=version)
+
+![Static Badge](https://img.shields.io/badge/macOS-11%2B-green)
+![Static Badge](https://img.shields.io/badge/Linux-blue)
+![Static Badge](https://img.shields.io/badge/FreeBSD-red)
+
+![Static Badge](https://img.shields.io/badge/amd64-green)
+![Static Badge](https://img.shields.io/badge/arm-blue)
+
+
+PyHw, a neofetch-like command line tool for fetching system information but written mostly in Python. **Currently, this project is still in the initial stage, only Linux, macOS, and FreeBSD are supported.**
+
+This project is a Python reimplementation of [neofetch](https://github.com/dylanaraps/neofetch) and references the [fastfetch](https://github.com/fastfetch-cli/fastfetch) project for logo style settings. Since this project is implemented in Python, it will be easier to maintain and extend than bash and c implementation. Also, this project only relies on the Python standard library, so you can run it on any device that has a Python environment (I hope so 🤔).
+
+
+[//]: # (![demo]&#40;https://i2.imgs.ovh/d/BQACAgUAAx0EUvSR8wACMvpmyFVohzKxLcUdLiJaEa3wlo_OrQACuw4AAoX-QVaSpG0-rTAeRTUE&#41;)
+![demo](https://files.catbox.moe/xx58xy.jpg)
+
+
+
+
+
+## Install
+There are already a lot of similar tools so you can choose any of them; they're all essentially no different. If you want to try this tool, just install it directly by pip.
+```shell
+pip install pyhw
+```
+To upgrade pyhw:
+```shell
+pip install pyhw -U
+# or
+pip install pyhw --upgrade
+```
+You can then use this tool directly from the command line with the following command, just like neofetch.
+```shell
+pyhw
+# or
+python -m pyhw
+```
+Please note that the command line entry for __pyhw__ is created by pip, and depending on the user, this entry may not in the __system PATH__. If you encounter this problem, pip will give you a prompt, follow the prompts to add entry to the __system PATH__.
+
+### Install by pipx
+**pipx** is an amazing tool to help you install and run applications written in Python. It is more like **brew** or **apt**. You can find more information about it here [pipx](https://github.com/pypa/pipx).
+
+You can install pyhw by the following command:
+```shell
+pipx install pyhw
+```
+You can then use this tool directly from the command line with the following command, just like neofetch.
+```shell
+pyhw
+```
+
+### Important note about debian 12:
+If you use system pip to install pyhw, you will encounter this problem on debian12 and some related distributions (like Ubuntu 24.04):
+```text
+error: externally-managed-environment
+
+× This environment is externally managed
+╰─> To install Python packages system-wide, try apt install
+    python3-xyz, where xyz is the package you are trying to
+    install.
+    
+    If you wish to install a non-Debian-packaged Python package,
+    create a virtual environment using python3 -m venv path/to/venv.
+    Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make
+    sure you have python3-full installed.
+    
+    For more information visit http://rptl.io/venv
+
+note: If you believe this is a mistake, please contact your Python installation or OS distribution provider. You can override this, at the risk of breaking your Python installation or OS, by passing --break-system-packages.
+hint: See PEP 668 for the detailed specification.
+```
+This is due to the fact that system python is not supposed to be managed by pip. You can simply use **pipx** to install **pyhw**. Or you can use a virtual environment (venv) or force remove this restriction (not recommended).
+
+## Tested OS
+* macOS arm64, x86_64
+* Linux arm64, x86_64
+* FreeBSD arm64
+
+
+## Build from source
+Currently, build process relay on swiftc and macOS IOKit framework. To build package from source, you need a Mac machine with macOS 11 and newer.
+
+### Dependencies
+This package was originally implemented in pure python and only depends on the python standard library. However, in subsequent development, the code for the pci part was separated into a separate package **pypci-ng**, which can be obtained using pip (or check out [this](https://github.com/xiaoran007/pypci) GitHub repository).
+
+### Build tools
+Make sure the following Python build tools are already installed.
+* setuptools
+* build
+* twine
+
+### Build package
+clone the project, and run:
+```shell
+python -m build
+```
+After the build process, the source package and the binary whl package can be found in the dist folder. Then you can use the following command to install the new package.
+```shell
+pip install dist/*.whl --force-reinstall
+```
+Or simply type:
+```shell
+make build
+make install
+```
+If you have docker installed, you can test this package through docker by type:
+```shell
+make test # local build
+make test-pypi # release version
+```

pyhw-0.7.3/README.md

@@ -0,0 +1,114 @@
+# PyHw
+[![Downloads](https://static.pepy.tech/badge/pyhw)](https://pepy.tech/project/pyhw)
+![PyPI - Version](https://img.shields.io/pypi/v/pyhw?label=version)
+
+![Static Badge](https://img.shields.io/badge/macOS-11%2B-green)
+![Static Badge](https://img.shields.io/badge/Linux-blue)
+![Static Badge](https://img.shields.io/badge/FreeBSD-red)
+
+![Static Badge](https://img.shields.io/badge/amd64-green)
+![Static Badge](https://img.shields.io/badge/arm-blue)
+
+
+PyHw, a neofetch-like command line tool for fetching system information but written mostly in Python. **Currently, this project is still in the initial stage, only Linux, macOS, and FreeBSD are supported.**
+
+This project is a Python reimplementation of [neofetch](https://github.com/dylanaraps/neofetch) and references the [fastfetch](https://github.com/fastfetch-cli/fastfetch) project for logo style settings. Since this project is implemented in Python, it will be easier to maintain and extend than bash and c implementation. Also, this project only relies on the Python standard library, so you can run it on any device that has a Python environment (I hope so 🤔).
+
+
+[//]: # (![demo](https://i2.imgs.ovh/d/BQACAgUAAx0EUvSR8wACMvpmyFVohzKxLcUdLiJaEa3wlo_OrQACuw4AAoX-QVaSpG0-rTAeRTUE))
+![demo](https://files.catbox.moe/xx58xy.jpg)
+
+
+
+
+
+## Install
+There are already a lot of similar tools so you can choose any of them; they're all essentially no different. If you want to try this tool, just install it directly by pip.
+```shell
+pip install pyhw
+```
+To upgrade pyhw:
+```shell
+pip install pyhw -U
+# or
+pip install pyhw --upgrade
+```
+You can then use this tool directly from the command line with the following command, just like neofetch.
+```shell
+pyhw
+# or
+python -m pyhw
+```
+Please note that the command line entry for __pyhw__ is created by pip, and depending on the user, this entry may not in the __system PATH__. If you encounter this problem, pip will give you a prompt, follow the prompts to add entry to the __system PATH__.
+
+### Install by pipx
+**pipx** is an amazing tool to help you install and run applications written in Python. It is more like **brew** or **apt**. You can find more information about it here [pipx](https://github.com/pypa/pipx).
+
+You can install pyhw by the following command:
+```shell
+pipx install pyhw
+```
+You can then use this tool directly from the command line with the following command, just like neofetch.
+```shell
+pyhw
+```
+
+### Important note about debian 12:
+If you use system pip to install pyhw, you will encounter this problem on debian12 and some related distributions (like Ubuntu 24.04):
+```text
+error: externally-managed-environment
+
+× This environment is externally managed
+╰─> To install Python packages system-wide, try apt install
+    python3-xyz, where xyz is the package you are trying to
+    install.
+    
+    If you wish to install a non-Debian-packaged Python package,
+    create a virtual environment using python3 -m venv path/to/venv.
+    Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make
+    sure you have python3-full installed.
+    
+    For more information visit http://rptl.io/venv
+
+note: If you believe this is a mistake, please contact your Python installation or OS distribution provider. You can override this, at the risk of breaking your Python installation or OS, by passing --break-system-packages.
+hint: See PEP 668 for the detailed specification.
+```
+This is due to the fact that system python is not supposed to be managed by pip. You can simply use **pipx** to install **pyhw**. Or you can use a virtual environment (venv) or force remove this restriction (not recommended).
+
+## Tested OS
+* macOS arm64, x86_64
+* Linux arm64, x86_64
+* FreeBSD arm64
+
+
+## Build from source
+Currently, build process relay on swiftc and macOS IOKit framework. To build package from source, you need a Mac machine with macOS 11 and newer.
+
+### Dependencies
+This package was originally implemented in pure python and only depends on the python standard library. However, in subsequent development, the code for the pci part was separated into a separate package **pypci-ng**, which can be obtained using pip (or check out [this](https://github.com/xiaoran007/pypci) GitHub repository).
+
+### Build tools
+Make sure the following Python build tools are already installed.
+* setuptools
+* build
+* twine
+
+### Build package
+clone the project, and run:
+```shell
+python -m build
+```
+After the build process, the source package and the binary whl package can be found in the dist folder. Then you can use the following command to install the new package.
+```shell
+pip install dist/*.whl --force-reinstall
+```
+Or simply type:
+```shell
+make build
+make install
+```
+If you have docker installed, you can test this package through docker by type:
+```shell
+make test # local build
+make test-pypi # release version
+```

{pyhw-0.1.3b0 → pyhw-0.7.3}/pyproject.toml

@@ -4,15 +4,20 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyhw"
-version = "0.1.3b"
+version = "0.7.3"
 description = "PyHw, a neofetch-like command line tool for fetching system information but written mostly in python."
+keywords = ["neofetch", "system information", "command line tool", "python", "hardware information", "fastfetch", "fetching"]
 authors = [
     { name = "Xiao Ran", email = "xiaoran.007@icloud.com" }
 ]
 readme = "README.md"
 license = {text = "BSD-3-Clause"}
 requires-python = ">=3.9"
+dependencies = [
+    "pypci-ng>=0.0.10"
+]
 classifiers = [
+    "Development Status :: 4 - Beta",
     "Programming Language :: Python :: 3",
     "License :: OSI Approved :: BSD License",
     "Operating System :: OS Independent"
@@ -25,7 +30,7 @@ package-dir = {"" = "src"}
 include-package-data = true
 
 [tool.setuptools.package-data]
-"pyhw" = ["frontend/logo/ascii/*.pyhw"]
+"pyhw" = ["frontend/logo/ascii/*.pyhw", "library/lib/*.dylib"]
 
 [project.scripts]
 pyhw = "pyhw.__main__:main"

pyhw-0.7.3/src/pyhw/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.7.3'

pyhw-0.7.3/src/pyhw/__main__.py

@@ -0,0 +1,46 @@
+from .frontend import Printer
+from .backend import Data
+from .backend.title import TitleDetect
+from .backend.host import HostDetect
+from .backend.kernel import KernelDetect
+from .backend.shell import ShellDetect
+from .backend.uptime import UptimeDetect
+from .backend.os import OSDetect
+from .backend.cpu import CPUDetect
+from .backend.gpu import GPUDetect
+from .backend.memory import MemoryDetect
+from .backend.nic import NICDetect
+from .backend.npu import NPUDetect
+from .pyhwUtil import createDataString
+from .pyhwUtil import getOS, selectOSLogo
+
+
+def main():
+    current_os = getOS()
+    if current_os not in ["linux", "macos", "freebsd"]:
+        print(f"Only Linux, macOS, and FreeBSD is supported for now. Current os: {current_os}")
+        return
+    data = Data()
+    data.title = TitleDetect(os=current_os).getTitle().title
+    data.Host = HostDetect(os=current_os).getHostInfo().model
+    data.Kernel = KernelDetect(os=current_os).getKernelInfo().kernel
+    data.Shell = ShellDetect(os=current_os).getShellInfo().info
+    data.Uptime = UptimeDetect(os=current_os).getUptime().uptime
+    data.OS = OSDetect(os=current_os).getOSInfo().prettyName
+    data.CPU = CPUDetect(os=current_os).getCPUInfo().cpu
+    gpu_info = GPUDetect(os=current_os).getGPUInfo()
+    if gpu_info.number > 0:
+        data.GPU = gpu_info.gpus
+    data.Memory = MemoryDetect(os=current_os).getMemoryInfo().memory
+    nic_info = NICDetect(os=current_os).getNICInfo()
+    if nic_info.number > 0:
+        data.NIC = nic_info.nics
+    npu_info = NPUDetect(os=current_os).getNPUInfo()
+    if npu_info.number > 0:
+        data.NPU = npu_info.npus
+
+    Printer(logo_os=selectOSLogo(OSDetect(os=current_os).getOSInfo().id), data=createDataString(data)).cPrint()
+
+
+if __name__ == "__main__":
+    main()

{pyhw-0.1.3b0 → pyhw-0.7.3}/src/pyhw/backend/backendBase.py

@@ -19,3 +19,5 @@ class Data:
     CPU = "Default Value"
     GPU = ["Default Value"]
     Memory = "Default Value"
+    NIC = ["Default Value"]
+    NPU = ["Default Value"]

pyhw-0.7.3/src/pyhw/backend/cpu/bsd.py

@@ -0,0 +1,12 @@
+from .cpuInfo import CPUInfo
+from ...pyhwUtil import sysctlGetString, sysctlGetInt, getArch
+
+
+class CPUDetectBSD:
+    def __init__(self):
+        self.__cpuInfo = CPUInfo()
+
+    def getCPUInfo(self):
+        self.__cpuInfo.cpu = sysctlGetString("hw.model")
+        return self.__cpuInfo
+

{pyhw-0.1.3b0 → pyhw-0.7.3}/src/pyhw/backend/cpu/cpuBase.py

@@ -1,4 +1,6 @@
 from .linux import CPUDetectLinux
+from .macos import CPUDetectMacOS
+from .bsd import CPUDetectBSD
 from ...pyhwException import OSUnsupportedException
 
 
@@ -9,5 +11,9 @@ class CPUDetect:
     def getCPUInfo(self):
         if self.OS == "linux":
             return CPUDetectLinux().getCPUInfo()
+        elif self.OS == "macos":
+            return CPUDetectMacOS().getCPUInfo()
+        elif self.OS == "freebsd":
+            return CPUDetectBSD().getCPUInfo()
         else:
             raise OSUnsupportedException("Unsupported operating system")

pyhw-0.7.3/src/pyhw/backend/cpu/cpuInfo.py

@@ -0,0 +1,13 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class CPUInfo:
+    """
+    Class to store CPU information. Print key: cpu
+    """
+    def __init__(self):
+        self.cpu = ""
+        self.model = ""
+        self.cores = ""
+        self.frequency = ""

{pyhw-0.1.3b0 → pyhw-0.7.3}/src/pyhw/backend/cpu/linux.py

@@ -1,23 +1,18 @@
-from dataclasses import dataclass
 import re
 import os
-
-
-@dataclass
-class CPUInfoLinux:
-    cpu = ""
-    model = ""
-    cores = ""
-    frequency = ""
+from .cpuInfo import CPUInfo
 
 
 class CPUDetectLinux:
     def __init__(self):
-        self.__cpuInfo = CPUInfoLinux()
+        self.__cpuInfo = CPUInfo()
 
     def getCPUInfo(self):
         self.__getCPUInfo()
         self.__modelClean()
+        self.__handleSBC()
+        if self.__cpuInfo.model == "":
+            self.__cpuInfo.model = "Unknown"
         if self.__cpuInfo.model != "":
             self.__cpuInfo.cpu = self.__cpuInfo.model
             if self.__cpuInfo.cores != "":
@@ -53,9 +48,32 @@ class CPUDetectLinux:
             else:
                 for line in cpu_info.split("\n"):
                     if line.startswith("cpu MHz") or line.startswith("clock"):
-                        self.__cpuInfo.frequency = float(line.split(":")[1].strip()) / 1000  # Ghz
+                        self.__cpuInfo.frequency = f"{round(float(line.split(':')[1].strip()) / 1000, 2)} Ghz"  # Ghz
                         break
 
     def __modelClean(self):
         self.__cpuInfo.model = self.__cpuInfo.model.replace("(R)", "")
         self.__cpuInfo.model = self.__cpuInfo.model.replace("(TM)", "")
+
+    def __handleSBC(self):
+        # some values should be double-checked
+        # Info source: https://github.com/raspberrypi/firmware/tree/master/boot
+        if os.path.exists("/sys/firmware/devicetree/base/compatible"):
+            try:
+                with open("/sys/firmware/devicetree/base/compatible", "r") as f:
+                    compatible = f.read().strip()
+            except FileNotFoundError:
+                compatible = ""
+            if "raspberrypi" in compatible:
+                model = compatible.split(",")[-1]
+                if model.startswith("bcm"):
+                    self.__cpuInfo.model = model.upper()
+            elif "orangepi" in compatible:
+                if "allwinner" in compatible:
+                    model = compatible.split(",")[-1]
+                    if model.startswith("sun"):
+                        self.__cpuInfo.model = f"Allwinner {model.split('-')[-1].upper()} ({model})"
+        else:
+            pass
+
+

pyhw-0.7.3/src/pyhw/backend/cpu/macos.py

@@ -0,0 +1,71 @@
+from .cpuInfo import CPUInfo
+from ...pyhwUtil import sysctlGetString, sysctlGetInt, getArch
+
+
+class CPUDetectMacOS:
+    def __init__(self):
+        self.__cpuInfo = CPUInfo()
+        self.__arch = getArch()
+        self.__pCore = 0
+        self.__eCore = 0
+
+    def getCPUInfo(self):
+        if self.__arch == "aarch64":
+            self.__getCPUModel()
+            self.__AppleSiliconBaseFrequency()
+            self.__handleAppleSilicon()
+            self.__cpuInfo.cpu = f"{self.__cpuInfo.model} ({self.__pCore}P, {self.__eCore}E) @ {self.__cpuInfo.frequency}"
+        else:
+            self.__getCPUModel()
+            self.__getCPUCores()
+            self.__getCPUFrequency()
+            # need test on Intel Macs.
+            self.__cpuInfo.cpu = f"{self.__cpuInfo.model.replace('CPU', f'({self.__cpuInfo.cores})')}"
+        return self.__cpuInfo
+
+    def __getCPUModel(self):
+        model = sysctlGetString("machdep.cpu.brand_string")
+        model = model.replace("(R)", "")
+        model = model.replace("(TM)", "")
+        self.__cpuInfo.model = model
+
+    def __getCPUCores(self):
+        cores = sysctlGetString("hw.logicalcpu_max")
+        self.__cpuInfo.cores = cores
+
+    def __getCPUFrequency(self):
+        # sysctl doesn't provide the exact CPU frequency on Apple Silicon Macs, there are some indirect methods
+        # to get the CPU frequency, but can not integrate with Python directly.
+        # C-Based helper module will be added later.
+        # See https://github.com/fastfetch-cli/fastfetch/blob/dev/src/detection/cpu/cpu_apple.c for more details.
+        freq = sysctlGetString("hw.cpufrequency")
+        self.__cpuInfo.frequency = freq
+
+    def __handleAppleSilicon(self):
+        nlevels = sysctlGetInt("hw.nperflevels")
+        if nlevels is not None and nlevels == 2:    # currently, Apple Silicon chip only has 2 performance levels.
+            pcore = sysctlGetInt("hw.perflevel0.logicalcpu_max")    # level 0 is P-core
+            ecore = sysctlGetInt("hw.perflevel1.logicalcpu_max")    # level 1 is E-core
+            if pcore is not None and ecore is not None:
+                self.__pCore = pcore
+                self.__eCore = ecore
+
+    def __AppleSiliconBaseFrequency(self):
+        # see https://en.wikipedia.org/wiki/Apple_silicon#M_series for more details.
+        freq = {
+            "Apple M1": "2.30 GHz",
+            "Apple M1 Pro": "2.32 GHz",
+            "Apple M1 Max": "2.32 GHz",
+            "Apple M1 Ultra": "2.32 GHz",
+            "Apple M2": "3.50 GHz",
+            "Apple M2 Pro": "3.50 GHz",
+            "Apple M2 Max": "3.69 GHz",
+            "Apple M2 Ultra": "3.70 Ghz",
+            "Apple M3": "4.05 GHz",
+            "Apple M3 Pro": "4.05 GHz",
+            "Apple M3 Max": "4.05 GHz",
+            "Apple M4": "4.40 GHz",
+            "Apple M4 Pro": "4.40 GHz",
+            "Apple M4 Max": "4.40 GHz"
+        }
+        self.__cpuInfo.frequency = freq.get(self.__cpuInfo.model, "Unknown")

pyhw-0.7.3/src/pyhw/backend/gpu/bsd.py

@@ -0,0 +1,7 @@
+from .linux import GPUDetectLinux
+
+
+class GPUDetectBSD(GPUDetectLinux):
+    def __init__(self):
+        super().__init__()
+

{pyhw-0.1.3b0 → pyhw-0.7.3}/src/pyhw/backend/gpu/gpuBase.py

@@ -1,4 +1,6 @@
 from .linux import GPUDetectLinux
+from .macos import GPUDetectMacOS
+from .bsd import GPUDetectBSD
 
 
 class GPUDetect:
@@ -8,5 +10,9 @@ class GPUDetect:
     def getGPUInfo(self):
         if self.OS == "linux":
             return GPUDetectLinux().getGPUInfo()
+        elif self.OS == "macos":
+            return GPUDetectMacOS().getGPUInfo()
+        elif self.OS == "freebsd":
+            return GPUDetectBSD().getGPUInfo()
         else:
             raise NotImplementedError("Unsupported operating system")

pyhw-0.7.3/src/pyhw/backend/gpu/gpuInfo.py

@@ -0,0 +1,8 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class GPUInfo:
+    def __init__(self):
+        self.number = 0
+        self.gpus = []

pyhw-0.7.3/src/pyhw/backend/gpu/linux.py

@@ -0,0 +1,46 @@
+import subprocess
+from .gpuInfo import GPUInfo
+from ..cpu import CPUDetect
+from ...pyhwUtil import getArch
+import pypci
+
+
+class GPUDetectLinux:
+    def __init__(self):
+        self.__gpuInfo = GPUInfo()
+
+    def getGPUInfo(self):
+        self.__getGPUInfo()
+        self.__sortGPUList()
+        return self.__gpuInfo
+
+    def __getGPUInfo(self):
+        gpu_devices = pypci.PCI().FindAllVGA()
+        if len(gpu_devices) == 0:
+            self.__handleNonePciDevices()
+        else:
+            for device in gpu_devices:
+                if device.subsystem_device_name != "":
+                    device_name = f"{device.vendor_name} {device.device_name} ({device.subsystem_device_name})"
+                else:
+                    device_name = f"{device.vendor_name} {device.device_name}"
+                self.__gpuInfo.gpus.append(self.__gpuNameClean(device_name))
+                self.__gpuInfo.number += 1
+
+    def __handleNonePciDevices(self):
+        # if detector can't find any VGA/Display/3D GPUs, assume the host is a sbc device, this function is a placeholder for a more advanced method.
+        if getArch() == "aarch64" or getArch() == "arm32":
+            self.__gpuInfo.number = 1
+            self.__gpuInfo.gpus.append(f"{CPUDetect(os='linux').getCPUInfo().model} [SOC Integrated]")
+        else:
+            self.__gpuInfo.number = 1
+            self.__gpuInfo.gpus.append("Not found")
+
+    @staticmethod
+    def __gpuNameClean(gpu_name: str):
+        gpu_name_clean = gpu_name.replace("Corporation ", "")
+        return gpu_name_clean
+
+    def __sortGPUList(self):
+        self.__gpuInfo.gpus.sort()
+