pyhw 0.2.0b0__tar.gz → 0.2.2b0__tar.gz

{pyhw-0.2.0b0/src/pyhw.egg-info → pyhw-0.2.2b0}/PKG-INFO

@@ -1,10 +1,12 @@
 Metadata-Version: 2.1
 Name: pyhw
-Version: 0.2.0b0
+Version: 0.2.2b0
 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
@@ -16,20 +18,56 @@ License-File: LICENSE
 ![PyPI - Downloads](https://img.shields.io/pypi/dw/pyhw?label=PyPI)
 ![PyPI - Version](https://img.shields.io/pypi/v/pyhw?label=version)
 
+![Static Badge](https://img.shields.io/badge/macOS-brightgreen)
+![Static Badge](https://img.shields.io/badge/Linux-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 part of the linux systems and macOS 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 🤔)
+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 🤔).
 
+## 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 --upgrade
+```
 You can then use this tool directly from the command line with the following command, just like neofetch.
 ```shell
 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__.
+
+### Important note about debian 12:
+If you use system pip to install pyhw, you will encounter this problem on debian12 and some related distributions:
+```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 use a virtual environment (venv) or force remove this restriction (not recommended).
+
+## Supported (Tested) OS
+* macOS arm64, x86_64
+* debian-based distro x86_64
+* RaspberryPi OS arm64
+
 
 ## Build from source
 ### Build tools

pyhw-0.2.2b0/README.md

@@ -0,0 +1,72 @@
+# PyHw
+![PyPI - Downloads](https://img.shields.io/pypi/dw/pyhw?label=PyPI)
+![PyPI - Version](https://img.shields.io/pypi/v/pyhw?label=version)
+
+![Static Badge](https://img.shields.io/badge/macOS-brightgreen)
+![Static Badge](https://img.shields.io/badge/Linux-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 part of the linux systems and macOS 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 🤔).
+
+## 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 --upgrade
+```
+You can then use this tool directly from the command line with the following command, just like neofetch.
+```shell
+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__.
+
+### Important note about debian 12:
+If you use system pip to install pyhw, you will encounter this problem on debian12 and some related distributions:
+```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 use a virtual environment (venv) or force remove this restriction (not recommended).
+
+## Supported (Tested) OS
+* macOS arm64, x86_64
+* debian-based distro x86_64
+* RaspberryPi OS arm64
+
+
+## Build from source
+### 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
+```
+or you can use the old setup.py style command:
+```shell
+python setup.py sdist bdist_wheel
+```
+After the build process, the source package and the binary whl package can be found in the dist folder.

{pyhw-0.2.0b0 → pyhw-0.2.2b0}/pyproject.toml

@@ -4,8 +4,9 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyhw"
-version = "0.2.0b"
+version = "0.2.2b"
 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" }
 ]
@@ -13,6 +14,7 @@ readme = "README.md"
 license = {text = "BSD-3-Clause"}
 requires-python = ">=3.9"
 classifiers = [
+    "Development Status :: 4 - Beta",
     "Programming Language :: Python :: 3",
     "License :: OSI Approved :: BSD License",
     "Operating System :: OS Independent"

{pyhw-0.2.0b0 → pyhw-0.2.2b0}/src/pyhw/backend/cpu/linux.py

@@ -10,6 +10,9 @@ class CPUDetectLinux:
     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 != "":
@@ -51,3 +54,30 @@ class CPUDetectLinux:
     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
+        raspberry_pi_soc_map = {
+            "Raspberry Pi 2 Model B Rev 1.1": "BCM2836",
+            "Raspberry Pi 2 Model B Rev 1.2": "BCM2837",
+            "Raspberry Pi 3 Model B": "BCM2837",
+            "Raspberry Pi 3 Model B+": "BCM2837",
+            "Raspberry Pi 4 Model B": "BCM2711",
+            "Raspberry Pi 5": "BCM2712",
+        }
+        if os.path.exists("/sys/firmware/devicetree/base/model"):
+            try:
+                with open("/sys/firmware/devicetree/base/model", "r") as f:
+                    model = f.read().strip()
+            except FileNotFoundError:
+                model = ""
+            if "Raspberry Pi" in model:
+                map_cpu = raspberry_pi_soc_map.get(model, "Unknown")
+                if map_cpu != "Unknown":
+                    self.__cpuInfo.model = map_cpu
+            else:
+                pass
+        else:
+            pass
+

pyhw-0.2.2b0/src/pyhw/backend/host/linux.py

@@ -0,0 +1,51 @@
+"""
+    In dev.
+"""
+from ...pyhwUtil import getArch
+from .hostInfo import HostInfo
+import os
+
+
+class HostDetectLinux:
+    def __init__(self):
+        self.__hostInfo = HostInfo()
+        self.__arch = getArch()
+
+    def getHostInfo(self):
+        self.__getModel()
+        return self.__hostInfo
+
+    def __getModel(self):
+        if self.__arch in ["x86_64", "x86"]:
+            try:
+                with open("/sys/devices/virtual/dmi/id/product_name", "r") as f:
+                    self.__hostInfo.name = f.read().strip()
+                with open("/sys/devices/virtual/dmi/id/product_version", "r") as f:
+                    self.__hostInfo.version = f.read().strip()
+                self.__hostInfo.model = self.__hostInfo.name + " " + self.__hostInfo.version
+            except FileNotFoundError:
+                pass
+        elif self.__arch in ["aarch64", "arm32"]:
+            # try to find dmi folder since some arm based desktops and servers may have same structure as x86_64 machines.
+            if os.path.exists("/sys/devices/virtual/dmi/id"):
+                try:
+                    with open("/sys/devices/virtual/dmi/id/product_name", "r") as f:
+                        self.__hostInfo.name = f.read().strip()
+                    with open("/sys/devices/virtual/dmi/id/product_version", "r") as f:
+                        self.__hostInfo.version = f.read().strip()
+                    self.__hostInfo.model = self.__hostInfo.name + " " + self.__hostInfo.version
+                except FileNotFoundError:
+                    pass
+            else:
+                # some single board computers may not have dmi folder, try to find model name in device tree.
+                try:
+                    with open("/sys/firmware/devicetree/base/model", "r") as f:
+                        self.__hostInfo.model = f.read().strip()
+                except FileNotFoundError:
+                    pass
+
+    def __getHostFamily(self):
+        pass
+
+    def __getHostProductName(self):
+        pass

{pyhw-0.2.0b0 → pyhw-0.2.2b0}/src/pyhw/frontend/color/colorConfig.py

@@ -21,13 +21,23 @@ class ColorConfigSet:
             return ColorConfigSetU.ubuntu
         elif self.__os_name == "ubuntu_small":
             return ColorConfigSetU.ubuntu_small
+        elif self.__os_name == "raspbian":
+            return ColorConfigSetR.raspbian
+        elif self.__os_name == "armbian":
+            return ColorConfigSetA.armbian
         else:
             return ColorConfigSetL.linux  # default to Linux
 
 
 @dataclass
 class ColorConfigSetA:
-    pass
+    armbian = {
+        "colors": [
+            ColorSet.COLOR_FG_RED
+        ],
+        "colorKeys": ColorSet.COLOR_FG_YELLOW,
+        "colorTitle": ColorSet.COLOR_FG_YELLOW
+    }
 
 
 @dataclass
@@ -90,6 +100,18 @@ class ColorConfigSetM:
     }
 
 
+@dataclass
+class ColorConfigSetR:
+    raspbian = {
+        "colors": [
+            ColorSet.COLOR_FG_RED,
+            ColorSet.COLOR_FG_GREEN
+        ],
+        "colorKeys": ColorSet.COLOR_FG_RED,
+        "colorTitle": ColorSet.COLOR_FG_GREEN
+    }
+
+
 @dataclass
 class ColorConfigSetU:
     ubuntu = {

pyhw-0.2.2b0/src/pyhw/frontend/logo/ascii/armbian.pyhw

@@ -0,0 +1,14 @@
+   █ █ █ █ █ █ █ █ █ █ █
+  ███████████████████████
+▄▄██                   ██▄▄
+▄▄██    ███████████    ██▄▄
+▄▄██   ██         ██   ██▄▄
+▄▄██   ██         ██   ██▄▄
+▄▄██   ██         ██   ██▄▄
+▄▄██   █████████████   ██▄▄
+▄▄██   ██         ██   ██▄▄
+▄▄██   ██         ██   ██▄▄
+▄▄██   ██         ██   ██▄▄
+▄▄██                   ██▄▄
+  ███████████████████████
+   █ █ █ █ █ █ █ █ █ █ █

pyhw-0.2.2b0/src/pyhw/frontend/logo/ascii/raspbian.pyhw

@@ -0,0 +1,23 @@
+   $2`.::///+:/-.        --///+//-:`
+ `+oooooooooooo:   `+oooooooooooo:
+  /oooo++//ooooo:  ooooo+//+ooooo.
+  `+ooooooo:-:oo-  +o+::/ooooooo:
+   `:oooooooo+``    `.oooooooo+-
+     `:++ooo/.        :+ooo+/.`$1
+        ...`  `.----.` ``..
+     .::::-``:::::::::.`-:::-`
+    -:::-`   .:::::::-`  `-:::-
+   `::.  `.--.`  `` `.---.``.::`
+       .::::::::`  -::::::::` `
+ .::` .:::::::::- `::::::::::``::.
+-:::` ::::::::::.  ::::::::::.`:::-
+::::  -::::::::.   `-::::::::  ::::
+-::-   .-:::-.``....``.-::-.   -::-
+ .. ``       .::::::::.     `..`..
+   -:::-`   -::::::::::`  .:::::`
+   :::::::` -::::::::::` :::::::.
+   .:::::::  -::::::::. ::::::::
+    `-:::::`   ..--.`   ::::::.
+      `...`  `...--..`  `...`
+            .::::::::::
+             `.-::::-`

{pyhw-0.2.0b0 → pyhw-0.2.2b0}/src/pyhw/pyhwUtil/pyhwUtil.py

@@ -1,6 +1,7 @@
 import platform
 from ..backend import Data
 import os
+from dataclasses import dataclass
 
 
 def getOS():
@@ -53,6 +54,12 @@ def createDataString(data: Data):
     return data_string
 
 
+@dataclass
+class SupportedOS:
+    ColorConfig = ["armbian", "debian", "fedora", "macOS", "raspbian", "ubuntu"]
+    AsciiLogo = ["armbian", "debian", "fedora", "macOS", "raspbian", "ubuntu"]
+
+
 def selectOSLogo(os_id: str):
     """
     Select the logo based on the os id and terminal size.
@@ -61,6 +68,10 @@ def selectOSLogo(os_id: str):
     """
     if getOS() == "macos":
         return os_id
+    if os_id in SupportedOS.ColorConfig and os_id in SupportedOS.AsciiLogo:
+        pass
+    else:
+        return "linux"
     rows_str, columns_str = os.popen('stty size', 'r').read().split()
     rows = int(rows_str)
     columns = int(columns_str)

{pyhw-0.2.0b0 → pyhw-0.2.2b0/src/pyhw.egg-info}/PKG-INFO

@@ -1,10 +1,12 @@
 Metadata-Version: 2.1
 Name: pyhw
-Version: 0.2.0b0
+Version: 0.2.2b0
 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
@@ -16,20 +18,56 @@ License-File: LICENSE
 ![PyPI - Downloads](https://img.shields.io/pypi/dw/pyhw?label=PyPI)
 ![PyPI - Version](https://img.shields.io/pypi/v/pyhw?label=version)
 
+![Static Badge](https://img.shields.io/badge/macOS-brightgreen)
+![Static Badge](https://img.shields.io/badge/Linux-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 part of the linux systems and macOS 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 🤔)
+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 🤔).
 
+## 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 --upgrade
+```
 You can then use this tool directly from the command line with the following command, just like neofetch.
 ```shell
 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__.
+
+### Important note about debian 12:
+If you use system pip to install pyhw, you will encounter this problem on debian12 and some related distributions:
+```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 use a virtual environment (venv) or force remove this restriction (not recommended).
+
+## Supported (Tested) OS
+* macOS arm64, x86_64
+* debian-based distro x86_64
+* RaspberryPi OS arm64
+
 
 ## Build from source
 ### Build tools

{pyhw-0.2.0b0 → pyhw-0.2.2b0}/src/pyhw.egg-info/SOURCES.txt

@@ -64,11 +64,13 @@ src/pyhw/frontend/color/colorSet.py
 src/pyhw/frontend/color/colorUtil.py
 src/pyhw/frontend/logo/__init__.py
 src/pyhw/frontend/logo/logoBase.py
+src/pyhw/frontend/logo/ascii/armbian.pyhw
 src/pyhw/frontend/logo/ascii/debian.pyhw
 src/pyhw/frontend/logo/ascii/fedora.pyhw
 src/pyhw/frontend/logo/ascii/fedora_small.pyhw
 src/pyhw/frontend/logo/ascii/linux.pyhw
 src/pyhw/frontend/logo/ascii/macOS.pyhw
+src/pyhw/frontend/logo/ascii/raspbian.pyhw
 src/pyhw/frontend/logo/ascii/ubuntu.pyhw
 src/pyhw/frontend/logo/ascii/ubuntu_small.pyhw
 src/pyhw/pyhwException/__init__.py

pyhw-0.2.0b0/README.md

@@ -1,36 +0,0 @@
-# PyHw
-![PyPI - Downloads](https://img.shields.io/pypi/dw/pyhw?label=PyPI)
-![PyPI - Version](https://img.shields.io/pypi/v/pyhw?label=version)
-
-
-
-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 part of the linux systems and macOS 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 🤔)
-
-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
-```
-You can then use this tool directly from the command line with the following command, just like neofetch.
-```shell
-pyhw
-```
-
-## Build from source
-### 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
-```
-or you can use the old setup.py style command:
-```shell
-python setup.py sdist bdist_wheel
-```
-After the build process, the source package and the binary whl package can be found in the dist folder.

pyhw-0.2.0b0/src/pyhw/backend/host/linux.py

@@ -1,38 +0,0 @@
-"""
-    In dev.
-"""
-from ...pyhwUtil import getArch
-from .hostInfo import HostInfo
-
-
-class HostDetectLinux:
-    def __init__(self):
-        self.__hostInfo = HostInfo()
-        self.__arch = getArch()
-
-    def getHostInfo(self):
-        self.__getModel()
-        return self.__hostInfo
-
-    def __getModel(self):
-        if self.__arch in ["x86_64", "x86"]:
-            try:
-                with open("/sys/devices/virtual/dmi/id/product_name", "r") as f:
-                    self.__hostInfo.name = f.read().strip()
-                with open("/sys/devices/virtual/dmi/id/product_version", "r") as f:
-                    self.__hostInfo.version = f.read().strip()
-                self.__hostInfo.model = self.__hostInfo.name + " " + self.__hostInfo.version
-            except FileNotFoundError:
-                pass
-        elif self.__arch in ["aarch64", "arm32"]:
-            try:
-                with open("/sys/firmware/devicetree/base/model", "r") as f:
-                    self.__hostInfo.model = f.read().strip()
-            except FileNotFoundError:
-                pass
-
-    def __getHostFamily(self):
-        pass
-
-    def __getHostProductName(self):
-        pass