Merge branch 'fix/xdg-path-fix-again' of github.com:szymon-jozef/zutui into fix/xdg-path-fix-again

* add PGKBUILD

* update README with AUR info

.gitignore

@@ -213,4 +213,7 @@ marimo/_lsp/
 __marimo__/
 
 # Streamlit
-.streamlit/secrets.toml
+.streamlit/secrets.toml
+
+# nix 
+result

PKGBUILD

@@ -0,0 +1,31 @@
+# Maintainer: <szymon_jozef@proton.me>
+_pkgname="zutui"
+pkgname="$_pkgname-git"
+pkgver="1.0.0.r8.ceefa47"
+pkgrel=4
+pkgdesc="TUI for accessing edziekanat of ZUT university"
+arch=("any")
+url="https://github.com/shv187/zutui"
+license=("MIT")
+depends=("python" "python-keyring" "python-textual" "python-appdirs" "python-beautifulsoup4" "python-requests")
+makedepends=("git" "python-build" "python-installer" "python-wheel" "python-setuptools")
+provides=("zutui")
+conflicts=("zutui")
+source=("$_pkgname::git+${url}.git")
+sha256sums=("SKIP")
+
+pkgver() {
+    cd "$_pkgname"
+    printf "1.0.0.r%s.%s" "$(git rev-list --count HEAD)" "$(git rev-parse --short HEAD)"
+}
+
+build() {
+	cd "$_pkgname"
+    python -m build --wheel --no-isolation
+}
+
+package() {
+	cd "$_pkgname"
+    python -m installer --destdir="$pkgdir" dist/*.whl
+    install -Dm644 LICENSE "$pkgdir/usr/share/licenses/$pkgname/LICENSE"
+}

README.md

@@ -10,15 +10,36 @@
 <img width="100%" height="auto" alt="Grades Page" src="https://github.com/user-attachments/assets/6536c74d-13a5-436e-af3d-5522216ce8c1" />
 
 # Usage
-### 1. Download:
+## 1. Download:
+### On Windows:
 ```
 pip install git+https://github.com/shv187/zutui.git
 ```
-### 2. Start:
+### Arch Linux:
+You can use PKGBUILD. Just run:
+```bash
+makepkg -si
+```
+or if you want to, you can use AUR helper of your choice. For example:
+```bash
+yay -S zutui-git
+```
+### Nix:
+```bash
+nix profile install github:shv187/zutui
+```
+
+### MacOs and other Linux distros:
+Most distros environments are externally managed by the system package manager, so the most straightforward way would be using something like `pipx`.
+```bash
+pipx install git+https://github.com/shv187/zutui.git
+```
+
+## 2. Start:
 ```
 zutui
 ```
-### 3. Enjoy :)
+## 3. Enjoy :)
 
 # Bindings
 `j` - Down
@@ -30,17 +51,12 @@ zutui
 `ctrl`+`q` - Quit
 
 # Sidenotes
-- config is stored @ `~/zutui/config.json`
+## Config
+- On Unix like is stored @ `~/.config/zutui/config.json`
+- On Windows is stored @ `~/zutui/config.json`
 - so are `grades_cache.json`
-- in plaintext.....
 
-##### As of right now I don't see any MUCH better way.
+##### Feel free to pull request if you're smarter :)
-
-##### I mean we could simply encrypt and decrypt it during runtime, but... does it really make it any more secure?
-
-##### And we can't really store it in any form of a _hash_ as we have to log in everytime with plain text anyways...
-
-##### However feel free to pull request if you're smarter :)
 
 # TODO:
 - [x] **Nothing**

flake.lock

@@ -0,0 +1,61 @@
+{
+  "nodes": {
+    "flake-utils": {
+      "inputs": {
+        "systems": "systems"
+      },
+      "locked": {
+        "lastModified": 1731533236,
+        "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1771369470,
+        "narHash": "sha256-0NBlEBKkN3lufyvFegY4TYv5mCNHbi5OmBDrzihbBMQ=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "0182a361324364ae3f436a63005877674cf45efb",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "flake-utils": "flake-utils",
+        "nixpkgs": "nixpkgs"
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

flake.nix

@@ -0,0 +1,60 @@
+{
+  description = "TUI for accessing edziekanat of ZUT university";
+
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    flake-utils.url = "github:numtide/flake-utils";
+  };
+
+  outputs =
+    {
+      self,
+      nixpkgs,
+      flake-utils,
+    }:
+
+    flake-utils.lib.eachDefaultSystem (
+      system:
+      let
+        pkgs = nixpkgs.legacyPackages.${system};
+      in
+      {
+        packages = {
+          default = pkgs.python3Packages.buildPythonApplication {
+            pname = "zutui";
+            version = "1.0.0";
+            src = ./.;
+            pyproject = true;
+
+            build-system = with pkgs.python3Packages; [
+              setuptools
+              wheel
+            ];
+
+            dependencies = with pkgs.python3Packages; [
+              keyring
+              textual
+              requests
+              beautifulsoup4
+              appdirs
+            ];
+
+            meta = with pkgs.lib; {
+              description = "TUI for accessing edziekanat of ZUT university";
+              homepage = "https://github.com/shv187/zutui";
+              license = licenses.mit;
+              mainProgram = "zutui";
+            };
+          };
+        };
+
+        devShells = {
+          default = pkgs.mkShell {
+            inputsFrom = [ self.packages.${system}.default ];
+          };
+        };
+      }
+
+    );
+
+}

setup.py

@@ -8,10 +8,13 @@ setup(
         "requests",
         "beautifulsoup4",
         "textual",
+        "keyring",
+        "pywin32; sys_platform == 'win32'",
+        "appdirs",
     ],
     entry_points={
         'console_scripts': [
             'zutui=zut_app.zutui:main',
         ],
     },
-)
+)

zut_app/config.py

@@ -1,19 +0,0 @@
-import os
-import platform
-
-USER_HOME = os.path.expanduser("~")
-WINDOWS_PATH = "zutui" # probably should be in %AppData% or something, but I'm not sure, so I won't change it
-LINUX_PATH = ".config/zutui"
-
-def get_config_path():
-    system = platform.system()
-    if system == "Windows":
-        APP_DIR = os.path.join(USER_HOME, WINDOWS_PATH)
-    elif system in ["Linux", "Darwin"]:
-        APP_DIR = os.path.join(USER_HOME, LINUX_PATH)
-    else:
-        print(f"System {system} not supported, aborting...")
-        exit(1)
-    if not os.path.exists(APP_DIR):
-        os.makedirs(APP_DIR)
-    return APP_DIR

zut_app/zut_client.py

@@ -1,13 +1,18 @@
 import requests
 from bs4 import BeautifulSoup
 import json
+from appdirs import user_config_dir, user_cache_dir
 import os
 
-from .config import get_config_path
+app_name = "zutui"
+app_author = "shv187"
 
-APP_DIR = get_config_path()
+CONFIG_DIR = user_config_dir(app_name, app_author)
+CACHE_DIR = user_cache_dir(app_name, app_author)
+os.makedirs(CACHE_DIR, exist_ok=True)
+os.makedirs(CONFIG_DIR, exist_ok=True)
 
-CACHE_FILE = os.path.join(APP_DIR, "grades_cache.json")
+CACHE_FILE = os.path.join(CACHE_DIR, "grades_cache.json")
 TIMEOUT = 10
 
 class ZUT:

zut_app/zutui.py

@@ -1,6 +1,9 @@
 import json
 import os
+import keyring
+from keyring.errors import KeyringError
 from datetime import datetime
+from appdirs import user_config_dir
 from textual.app import App, ComposeResult
 from textual.containers import Container
 from textual.widgets import Header, Footer, DataTable, Label, Button, Input
@@ -8,9 +11,8 @@ from textual.screen import Screen
 from textual.binding import Binding
 
 from .zut_client import ZUT
-from .config import get_config_path
 
-APP_DIR = get_config_path()
+APP_DIR = user_config_dir("zutui", "shv187")
 
 CONFIG_FILE = os.path.join(APP_DIR, "config.json")
 REFRESH_INTERVAL = 1800
@@ -54,9 +56,20 @@ class LoginScreen(Screen):
             if success:
                 try:
                     with open(CONFIG_FILE, "w") as f:
-                        json.dump({"username": user, "password": password}, f)
+                        json.dump({"username": user}, f)
+                        keyring.set_password("zutui", user, password)
+                except KeyringError as e:
+                    error = e
+                    self.app.call_from_thread(
+                            lambda:
+                                self.app.notify(
+                                    f"Błąd: {str(error)}",
+                                    title="Błąd zapisu hasła do systemowego menedżera haseł",
+                                    severity="warning",
+                                    timeout=5
+                                    )
+                            )
                 except: pass
-                
                 def do_switch():
                     self.app.switch_screen(DashboardScreen())
                 self.app.call_from_thread(do_switch)
@@ -406,7 +419,10 @@ class ZutApp(App):
             try:
                 with open(CONFIG_FILE, "r") as f:
                     creds = json.load(f)
-                    self.zut_client = ZUT(creds["username"], creds["password"])
+                    password = keyring.get_password("zutui", creds["username"])
+                    if password is None:
+                        raise ValueError("Hasło nie zostało znalezione")
+                    self.zut_client = ZUT(creds["username"], password)
                     self.push_screen(DashboardScreen())
             except:
                 self.push_screen(LoginScreen())