system-parse-lib 0.0.1__py3-none-any.whl

system-parse-lib/systemparselib.py

@@ -0,0 +1,171 @@
+import os, subprocess, getpass, socket
+from dataclasses import dataclass, asdict
+from functools import cache
+
+PCI_DEVICES = "/sys/bus/pci/devices"
+PCI_IDS_PATHS = (
+    "/usr/share/hwdata/pci.ids",
+    "/usr/share/misc/pci.ids",
+    "/usr/share/pci.ids",
+)
+VENDORS = {"10de": "NVIDIA", "1002": "AMD", "8086": "Intel"}
+
+@dataclass
+class GPU:
+    vendor: str
+    model: str
+    driver: str | None = None
+
+def _read_sysfs(path):
+    try:
+        with open(path) as f:
+            return f.read().strip()
+    except OSError:
+        return None
+
+@cache
+def _load_pci_ids():
+    """Returns {(vendor_id, device_id): name}"""
+    names = {}
+    for path in PCI_IDS_PATHS:
+        try:
+            f = open(path, encoding="utf-8", errors="replace")
+        except OSError:
+            continue
+        with f:
+            vendor = None
+            for line in f:
+                if line.startswith("#") or not line.strip():
+                    continue
+                if line.startswith("C "):
+                    break
+                if line.startswith("\t\t"):
+                    continue
+                if line.startswith("\t"):
+                    dev_id, _, name = line.strip().partition("  ")
+                    if vendor:
+                        names[(vendor, dev_id)] = name
+                else:
+                    vendor = line.split()[0]
+        break
+    return names
+
+class Main():
+    def __init__(self):
+        def get_distro_info():
+            if not os.path.exists('/etc/os-release'):
+                return None
+
+            info = {}
+
+            with open('/etc/os-release') as f:
+                for line in f:
+                    if '=' in line:
+                        key, value = line.strip().split('=', 1)
+                        info[key] = value
+            return info
+        self.distro_info = get_distro_info()
+
+    def get_distro_id(self):
+        if not self.distro_info:
+            return None
+        return self.distro_info.get('ID', '').strip('"')
+    
+    def get_username(self):
+        username = getpass.getuser()
+        return username
+
+    def get_kernel_version(self):
+        kernel_version = os.uname().release
+        return kernel_version
+
+    def get_uptime_seconds(self):
+        try:
+            with open("/proc/uptime") as f:
+                return int(float(f.read().split()[0]))
+        except (OSError, ValueError, IndexError):
+            return None
+    
+    def get_pretty_uptime(self):
+        seconds = self.get_uptime_seconds()
+        if seconds is None:
+            return None
+        
+        days, rem = divmod(seconds, 86400)
+        hours, rem = divmod(rem, 3600)
+        minutes = rem // 60
+
+        parts = []
+        if days:
+            parts.append(f"{days} day{'s' if days != 1 else ''}")
+        if hours:
+            parts.append(f"{hours} hour{'s' if hours != 1 else ''}")
+        if minutes or not parts:
+            parts.append(f"{minutes} minute{'s' if minutes != 1 else ''}")
+        return "up " + ", ".join(parts)
+
+    def get_session_type(self):
+        session_type = os.getenv('XDG_SESSION_TYPE')
+        if session_type:
+            return session_type
+        else:
+            return "Could not retrieve session type."
+    
+    def get_hostname(self):
+        hostname = socket.gethostname()
+        return hostname
+
+    def get_pretty_name(self):
+        if not self.distro_info:
+            return None
+        return self.distro_info.get('PRETTY_NAME', '').strip('"') 
+
+    def get_de(self):
+        desktop = os.environ.get("XDG_CURRENT_DESKTOP") or os.environ.get("DESKTOP_SESSION")
+        if desktop:
+            return desktop
+        return None
+
+    def get_cpu(self):
+        cpu = ""
+        try:
+            with open("/proc/cpuinfo", "r", encoding="utf-8") as file:
+                for line in file:
+                    if "model name" in line.lower():
+                        cpu = line.split(":", 1)[-1].strip()
+                        break
+        except FileNotFoundError:
+            return None
+        return cpu
+
+    def get_gpu(self):
+        gpus = []
+        try:
+            devices = sorted(os.listdir(PCI_DEVICES))
+        except OSError:
+            return gpus
+
+        ids = _load_pci_ids()
+
+        for dev in devices:
+            base = os.path.join(PCI_DEVICES, dev)
+
+            pci_class = _read_sysfs(base + "/class")
+            if not pci_class or not pci_class.startswith("0x03"):
+                continue
+
+            vendor_id = (_read_sysfs(base + "/vendor") or "")[2:]
+            device_id = (_read_sysfs(base + "/device") or "")[2:]
+
+            vendor = VENDORS.get(vendor_id, vendor_id)
+
+            name = ids.get((vendor_id, device_id), f"Device {device_id}")
+            model = name.split('[')[-1].split(']')[0] if '[' in name else name
+
+            driver = None
+            if os.path.exists(base + "/driver"):
+                driver = os.path.basename(os.path.realpath(base + "/driver"))
+
+            gpus.append(GPU(vendor=vendor, model=model, driver=driver))
+
+        return gpus

system_parse_lib-0.0.1.dist-info/METADATA

@@ -0,0 +1,97 @@
+Metadata-Version: 2.5
+Name: system-parse-lib
+Version: 0.0.1
+Summary: A for now small python library used for getting information about the system and hardware on linux. Dependency free! (well, not really)
+Project-URL: Homepage, https://github.com/black-mesa-studios/system-parse-lib
+Project-URL: Issues, https://github.com/black-mesa-studios/system-parse-lib/issues/
+Author-email: Artem Ivashyn <artem4ik15082013@gmail.com>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# system-parse-lib
+
+A small Python library for reading system information on Linux: OS name, kernel version, uptime, desktop environment, session type, CPU and GPU models and vendors, and basic user details. One module, no third-party dependencies, and no external commands: everything is read from `/etc`, `/proc` and `/sys`.
+
+![License](https://img.shields.io/badge/license-BSD--3--Clause-blue)
+![Python](https://img.shields.io/badge/python-3-yellow)
+![Platform](https://img.shields.io/badge/platform-Linux-lightgrey)
+
+**Documentation:** https://black-mesa-studios.github.io/system-parse-lib/
+
+## Features
+
+- Distro ID and pretty name, read from `/etc/os-release`
+- Current username and hostname
+- Kernel version and uptime (as seconds or readable text)
+- Desktop environment, from `XDG_CURRENT_DESKTOP` or `DESKTOP_SESSION`
+- Session type (Wayland, X11, tty), from `XDG_SESSION_TYPE`
+- CPU model, from `/proc/cpuinfo`
+- GPUs with vendor, model and kernel driver, from `/sys/bus/pci/devices`
+
+## Requirements
+
+- Linux
+- Python 3.10 or newer
+- Optional: a `pci.ids` file (from the `hwdata` or `pciids` package) so `get_gpu()` can show real model names
+
+## Installation
+
+There's no package yet. Clone the repo and copy `systemparselib.py` next to your script:
+
+```
+git clone https://github.com/black-mesa-studios/system-parse-lib.git
+cp system-parse-lib/systemparselib.py ./
+```
+
+## Usage
+
+```python
+import systemparselib
+
+sysinfo = systemparselib.Main()
+
+print(sysinfo.get_pretty_name())   # e.g. Arch Linux
+print(sysinfo.get_de())            # e.g. KDE
+print(sysinfo.get_session_type())  # e.g. wayland
+print(sysinfo.get_kernel_version())  # e.g. 6.11.2-arch1-1
+print(sysinfo.get_pretty_uptime())   # e.g. up 3 hours, 12 minutes
+print(sysinfo.get_cpu())           # e.g. AMD Ryzen 5 5600X 6-Core Processor
+print(sysinfo.get_gpu())           # e.g. [GPU(vendor='AMD', model='...', driver='amdgpu')]
+print(f"{sysinfo.get_username()}@{sysinfo.get_hostname()}")
+```
+
+## Functions
+
+All functions live on the `Main` class.
+
+| Function | Returns | Description |
+| --- | --- | --- |
+| `get_distro_id()` | `str \| None` | Short distro ID, like `arch` or `ubuntu` |
+| `get_pretty_name()` | `str \| None` | Human-readable OS name |
+| `get_username()` | `str` | Current user's name |
+| `get_hostname()` | `str` | Machine hostname |
+| `get_de()` | `str \| None` | Desktop environment, or `None` if none is set |
+| `get_session_type()` | `str` | Session type from `XDG_SESSION_TYPE`, like `wayland` or `x11` |
+| `get_kernel_version()` | `str` | Kernel release, like `6.11.2-arch1-1` |
+| `get_uptime_seconds()` | `int \| None` | Seconds since boot |
+| `get_pretty_uptime()` | `str \| None` | Readable uptime, like `up 3 hours, 12 minutes` |
+| `get_cpu()` | `str \| None` | CPU model name |
+| `get_gpu()` | `list[GPU]` | One `GPU(vendor, model, driver)` per display device |
+
+Full details are in the [documentation](https://black-mesa-studios.github.io/system-parse-lib/).
+
+## Testing
+
+`test.py` prints the output of every function so you can check it on your machine:
+
+```
+python3 test.py
+```
+
+## License
+
+Released under the [BSD 3-Clause License](LICENSE). Copyright 2026 Black Mesa Studios.

system_parse_lib-0.0.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+system-parse-lib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+system-parse-lib/systemparselib.py,sha256=kODuVzQGdlyUtvYuxVlvaFG8mZwaQF3e6_EBt9PD4H8,5033
+system_parse_lib-0.0.1.dist-info/METADATA,sha256=S9IJsE3vmx5g5AjtjN0s6_oCZ8LRMheluheSIkV9j3c,3818
+system_parse_lib-0.0.1.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+system_parse_lib-0.0.1.dist-info/licenses/LICENSE,sha256=OUU7y5SgDmsRqYh0PtRbnl7hdwCO-EHksvXNZiql3uo,1505
+system_parse_lib-0.0.1.dist-info/RECORD,,

system_parse_lib-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any

system_parse_lib-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Black Mesa Studios
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.