Fetchcord 3 release

MANIFEST.in

@@ -1,4 +1,4 @@
-include *.py
-include */*.py
-include */*/*.py
-include */*/*/*.py
+include resources/*.json
+include resources/fetchcord_conf.yml
+include resources/fetchcord_cmds.yml
+include resources/default.conf

README.md

@@ -13,30 +13,30 @@
     <a href="https://img.shields.io/badge/Compatible-MacOS%2FWindows%2FLinux-brightgreen?style=for-the-badge&logo=discord">
        <img src="https://cdn.discordapp.com/attachments/695182849476657223/742064452421288077/FetchDis.png"
     </a>
-
   </a>
 </p>
 
 # Table of content
+
 - [**Features**](#features)
 - [**To-Do**](#to-do)
-+ **Installing**
-    - [Install on (gnu/)linux](#installing-on-gnulinux)
-    - [Install on MacOS](#installing-on-macos)
-    - [Install on Windows](#installing-on-windows)
- + **Running**
-    - [Running on (gnu/)linux](#run)
-    - [Running on MacOS](#run-1)
-    - [Running on Windows](#run-2)
-- [**Configuration**](#Configuration)
+- **Installing**
+  - [Install on (gnu/)linux](#installing-on-gnulinux)
+  - [Install on MacOS](#installing-on-macos)
+  - [Install on Windows](#installing-on-windows)
+- **Running**
+  - [Running on (gnu/)linux](#run-on-linux)
+  - [Running on MacOS](#run-on-macos)
+  - [Running on Windows](#run-on-windows)
+- [**Configuration**](#configuration)
 - [**Arguments**](#arguments)
+- [**Website**](#website)
+- [**Examples**](#examples)
 
-+ [**Examples**](#examples)
-
-### Features
+## Features
 
 - [x] Distribution detection
- 
+
 - [x] Distribution Version
 
 - [x] Package detection
@@ -47,20 +47,23 @@
 
 - [x] Detecting Window Manager/Desktop Environment
 
-- [x] Detecting GPU/CPU and display it in a cycle (thanks to Hyper-KVM)
+- [x] Detecting GPU/CPU and display it in a cycle
 
 - [x] Flatpak support
 
-- [x] Add Snap support
-
 - [x] Add Windows support.
 
 - [x] Detect Window Manager/Desktop Environment version
 
 - [x] Periodic polling of info such as package count, RAM usage, etc.
 
+## To be tested
+
+- [ ] Snap support
+
+- [ ] GUI Frontend
 
-### To-Do
+## To-Do
 
 - [ ] Add more distributions (If your distro is not supported open an issue)
 
@@ -70,47 +73,68 @@
 
 - [ ] More GPUs?
 
-
 ## Installing on (GNU/)Linux
+
 NOTE: you need neofetch to be also installed for this to work.
-#### Via AUR
-On Arch Linux install this package for the git version: [fetchcord-git](https://aur.archlinux.org/packages/fetchcord-git/)
 
-Do note that this version is directly from master, for the stable release use [pip](#via-pip)
-#### Via Snap
-On systems with snap installed, you can run `sudo snap install fetchcord --classic` to install fetchcord.
+### Via pip (recommended)
 
-Note that like the AUR version, this version is directly from master, for the stable release use [pip](#via-pip) <!-- remove this if you're not automatically deploying it -->
-#### Via pip
-To Install fetchcord via pip you can run `pip3 install fetchcord`
+To install fetchcord via pip you can run `pip3 install fetchcord`
+
+(experimental) To install fetchcord with the GUI requirements, run `pip3 install fetchcord[gui]`
 
 If you want to remove FetchCord you can run `pip3 uninstall fetchcord`
 
-### Run
+### Via AUR
+
+On Arch Linux for the git testing version (the less stable version): [fetchcord-testing](https://aur.archlinux.org/packages/fetchcord-testing/)
+
+And the git version (synced with master): [fetchcord](https://aur.archlinux.org/packages/fetchcord/)
+
+### Via Snap
+
+On systems with snap installed, you can run `sudo snap install fetchcord --classic` to install fetchcord.
+
+Note that like the AUR version, this version is directly from master, for the stable release use [pip](#via-pip-recommended) <!-- remove this if you're not automatically deploying it -->
+
+### Run on Linux
 
 Once installed, simply run `fetchcord`. The program is also daemonizable meaning you can start it on boot using any method you prefer.
 
-If you get `fetchcord: command not found`,add `export PATH="$HOME/.local/bin:$PATH"` to your bashrc, or just run `python3 -m fetchcord`.
+If you get `fetchcord: command not found`,add `export PATH="$HOME/.local/bin:$PATH"` to your bashrc, or just run `python3 -m fetch_cord`.
 
 Optionally for systemd users there is a user-side `fetchcord.service` in this repo that can be installed to `~/.local/share/systemd/user/`, started and enabled on boot using `systemctl --user enable --now fetchcord`.
 
 ## Installing on MacOS
 
-To install FetchCord, run `pip3 install FetchCord`
-
 NOTE: you need neofetch to be also installed for this to work.
 
-### Run 
+To install fetchcord via pip you can run `pip3 install fetchcord`
+
+(experimental) To install fetchcord with the GUI requirements, run `pip3 install fetchcord[gui]`
+
+If you want to remove FetchCord you can run `pip3 uninstall fetchcord`
+
+### Run on MacOS
+
+Once installed, simply run `fetchcord`. The program is also daemonizable meaning you can start it on boot using any method you prefer.
 
-simply run `fetchcord`
+If you get `fetchcord: command not found`,add `export PATH="$HOME/.local/bin:$PATH"` to your zshrc, or just run `python3 -m fetch_cord`.
 
 ## Installing on Windows
 
-To install fetchcord on Windows run `python -m pip install fetchcord neofetch-win`. Alternatively, you can use the neofetch package from scoop as well (show more info at the expense of possible GPU detection, for now).
+To install fetchcord on Windows run `pip3 install fetchcord` or `python3 -m pip install fetchcord`.
+
+### Run on Windows
 
-### Run
 To run Fetchcord run `fetchcord`
 
+If you get `fetchcord: command not found`, add your python scripts folder to your PATH or use `python3 -m fetch_cord`.
+
+### GUI
+
+The fetchcord GUI can be opened by running `fetchcord --gui` in a terminal. A desktop file may be added in a future version.
+
 ### Configuration
 
 On Linux you can use the neofetch config file to:
@@ -132,6 +156,7 @@ And more
 default config path should be `~/.config/neofetch/config.conf`
 
 ## Arguments
+
 --nodistro, Don't show distro info.
 
 --nohardware, Don't show hardware info.
@@ -154,14 +179,33 @@ default config path should be `~/.config/neofetch/config.conf`
 
 --memtype, use GB or MB to show RAM.
 
+--gui, open the fetchcord GUI
+
 -h or --help, shows this information above.
+
+## Website
+
+Fetchcord now has a website! You can find this site over at https://fetchcord.github.io/ - please keep in mind this site is still currently work in progress though.
+
 ## Examples
 
 ### Operating Systems
+
 ![MacOS bigsur](Examples/mac.png) ![Windows 10](Examples/windows.png) ![Ubuntu](Examples/ubuntu.png)
+
 ### Terminals
+
 ![Konsole](Examples/konsole.png) ![Gnome terminal](Examples/gnometerm.png) ![Apple terminal](Examples/appleterm.png)
+
 ### Cpus
+
 ![Ryzen 9](Examples/ryzencpu.png) ![Intel i7](Examples/intelcpu.png) ![Intel pentium](Examples/pent.png)
+
 ### Hosts
+
 ![HP laptop](Examples/hp.png) ![TUF gaming laptop](Examples/tuf.png) ![Lenovo desktop](Examples/len.png)
+
+### GUI
+
+Note that the GUI version may look different depending on your OS and Qt theme.
+![GUI](Examples/gui.png)

fetch_cord/Config.py

@@ -0,0 +1,24 @@
+#!/usr/bin/env python3
+
+from importlib import resources
+import yaml
+
+
+class Config(dict):
+    def __init__(self, config_name: str = "fetchcord_conf.yml") -> None:
+        super(Config, self).__init__(
+            self.get_config(self.get_resource_path("fetch_cord.resources", config_name))
+        )
+
+    def get_resource_path(self, package, resource: str):
+        with resources.path(package, resource) as path:
+            return path
+
+    def get_config(self, path: str):
+        with open(path, "r") as stream:
+            try:
+                return yaml.safe_load(stream)
+            except yaml.YAMLError as exc:
+                print(exc)
+
+        return None

fetch_cord/Cycle.py

@@ -1,20 +1,91 @@
-from .computer.Computer import Computer
+# 1/usr/bin/env python3
+
+
+from threading import Event
 from typing import Dict
+from pypresence import Presence, exceptions
+import psutil
 
 
 class Cycle:
     name: str
 
+    app_id: str = None
     top_line: str = None
     bottom_line: str = None
     small_icon: str = None
+    time: str = None
+
+    debug: bool = False
+    rpc: Presence = None
+
+    stop: Event = None
+
+    def __init__(self, config: Dict, stop: Event = None):
+        if stop is None:
+            stop = Event()
+
+        for key in config:
+            setattr(self, key, config[key])
+        self.stop = stop
+
+    def __del__(self) -> None:
+        if self.rpc is not None:
+            self.rpc.close()
+
+    def setup(self, client_id: str) -> None:
+        self.rpc = Presence(int(client_id))
+
+    def try_connect(self) -> None:
+        while not self.stop.is_set():
+            try:
+                if self.debug:
+                    print('try_connect(name="{}")'.format(self.name))
+                self.rpc.connect()
+                break
+            except ConnectionRefusedError:
+                print(
+                    """
+RPC connection refused (is Discord open?); trying again in 30 seconds"""
+                )
+                self.wait(30)
+
+    def update(
+        self, client_id: str, app: str, bottom: str, top: str, icon: str, icon_id: str
+    ):
+        try:
+            self.rpc.update(
+                int(client_id),
+                state=bottom,
+                details=top,
+                large_image="big",
+                large_text=app,
+                small_image=icon_id,
+                small_text=icon,
+                start=psutil.boot_time(),
+            )
+
+            self.wait(int(self.time))
+
+            self.rpc.close()
+        # ConnectionResetError is here to avoid crashing
+        # if Discord is still just starting
+        except (ConnectionResetError, exceptions.InvalidID):
+            pass
+
+    def wait(self, n: float, interval_duration: float = 0.05) -> None:
+        """Wait for n seconds or until interrupted."""
 
-    def __init__(self, name: str, config: Dict[str, str], computer: Computer):
-        self.name = name
+        intervals = int(n / interval_duration)
+        for _ in range(intervals):
+            if self.stop.wait(interval_duration):
+                break
 
-        if "top_line" in config["top_line"]:
-            self.top_line = config["top_line"]
-        if "bottom_line" in config["bottom_line"]:
-            self.bottom_line = config["bottom_line"]
-        if "small_icon" in config["small_icon"]:
-            self.small_icon = config["small_icon"]
+    def __repr__(self) -> str:
+        return f"""
+{{name = {self.name}, \
+app_id = {self.app_id}, \
+top_line = {self.top_line}, \
+bottom_line = {self.bottom_line}, \
+small_icon = {self.small_icon}, \
+time = {self.time}}}"""