packuifw 1.0.0__py3-none-any.whl

pack_uifw/pack_uifw.py

@@ -0,0 +1,133 @@
+import sys
+import os
+import json
+import zipfile
+from pathlib import Path
+
+# --- EXCLUSION CONFIGURATION ---
+EXCLUDE_NAMES = {
+    'app.py', 'bot.py', 'server.py', 'firmware.db', 'requests.db',
+    'emergency.py', 'launcher.pyw', 'pack_uifw.py', 'emergency.log',
+    'submit_app.py', 'unpack_uifw.py', 'shell_manager_app.py',
+    'launcher_standalone.py'
+}
+EXCLUDE_EXTS = {'.db', '.log', '.pyc'}
+EXCLUDE_DIRS = {'cache', '__pycache__', 'installed_shells', '.git', '.idea', '.vscode'}
+
+
+def should_skip(path):
+    """Checks if a file or directory should be excluded from the archive."""
+    if path.name in EXCLUDE_NAMES:
+        return True
+    if path.suffix.lower() in EXCLUDE_EXTS:
+        return True
+    for part in path.parts:
+        if part in EXCLUDE_DIRS:
+            return True
+    return False
+
+
+def pack_folder(folder_path, out_path=None):
+    """Packs a shell folder into a .uifw archive."""
+    folder = Path(folder_path).resolve()
+    
+    if not folder.exists() or not folder.is_dir():
+        print("From folder err.")
+        return False
+
+    if out_path is None:
+        out = folder.parent / f"{folder.name}.uifw"
+    else:
+        out = Path(out_path).resolve()
+
+    meta_file = folder / 'shell.json'
+    if not meta_file.exists():
+        print('[!] Warning: shell.json not found in folder')
+
+    # Remove existing archive to avoid appending
+    if out.exists():
+        try:
+            out.unlink()
+        except PermissionError:
+            print(f"Cannot delete {out} — close File Explorer/archiver and try again.")
+            return False
+
+    count = 0
+    try:
+        with zipfile.ZipFile(out, 'w', zipfile.ZIP_DEFLATED) as z:
+            for item in folder.rglob('*'):
+                if item.is_dir():
+                    continue
+                if should_skip(item):
+                    continue
+                
+                arcname = item.relative_to(folder)
+                z.write(item, arcname)
+                count += 1
+
+        size_kb = out.stat().st_size // 1024
+        firmware_key = folder.name
+        print(f"Your firmware, named by {firmware_key}, builded in uifw. Success.")
+        return True
+        
+    except Exception as e:
+        print("Build err.")
+        return False
+
+
+def unpack_uifw(archive_path, dest_path=None):
+    """Unpacks a .uifw archive into the specified folder."""
+    archive = Path(archive_path).resolve()
+    
+    if not archive.exists():
+        print("From folder err.")
+        return False
+        
+    if dest_path is None:
+        dest = archive.parent / f"{archive.stem}_unpacked"
+    else:
+        dest = Path(dest_path).resolve()
+    
+    try:
+        dest.mkdir(parents=True, exist_ok=True)
+        
+        with zipfile.ZipFile(archive, 'r') as z:
+            z.extractall(dest)
+        
+        print(f"Your firmware, named by {archive.stem}, unpacked. Success.")
+        return True
+        
+    except Exception as e:
+        print("Build err.")
+        return False
+
+
+def main():
+    """Entry point for the CLI tool."""
+    args = sys.argv[1:]
+    
+    if len(args) < 2:
+        print("Usage:")
+        print('  pack_uifw pack <folder_path> [output_path]')
+        print('  pack_uifw unpack <file.uifw> [dest_folder]')
+        return
+
+    command = args[0].lower()
+    target = args[1]
+    optional_arg = args[2] if len(args) > 2 else None
+
+    if command == 'pack':
+        success = pack_folder(target, optional_arg)
+    elif command == 'unpack':
+        success = unpack_uifw(target, optional_arg)
+    else:
+        print(f"Unknown command: {command}")
+        print("Use 'pack' or 'unpack'.")
+        return
+
+    if not success:
+        sys.exit(1)
+
+
+if __name__ == '__main__':
+    main()

packuifw-1.0.0.dist-info/METADATA

@@ -0,0 +1,120 @@
+Metadata-Version: 2.4
+Name: packuifw
+Version: 1.0.0
+Summary: Tool for packing .uifw firmware from shell folders. For Firmware Authority
+Author: fa_creepyr
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# packuifw
+
+A tool for packing `.uifw` firmware from shell folders.
+Part of the **Firmware Authority** project.
+
+## What is .uifw
+
+`.uifw` is a ZIP archive with the `.uifw` extension that contains a Windows shell:
+
+```
+my_shell.uifw
+├── shell.json      metadata
+├── launcher.exe    launches the shell
+├── main.py         shell code
+└── assets/         wallpapers, cursors, sounds
+```
+
+## Installation
+
+```bash
+pip install packuifw
+```
+
+## Usage
+
+### CLI
+
+```bash
+pack_uifw <path_to_folder>
+```
+
+Creates `<folder_name>.uifw` next to the folder.
+
+Example:
+
+```bash
+pack_uifw C:\shellpacks\win98
+```
+
+Creates `C:\shellpacks\win98.uifw`.
+
+### GUI
+
+Run `pack_uifw` without arguments to open the window:
+
+```bash
+pack_uifw
+```
+
+- Folder: shell folder (`shell.json`, `main.py`, `assets/`)
+- Output: where to save `.uifw` (default — next to the folder)
+- Pack: start packing
+
+## Shell folder structure
+
+```
+my_shell/
+├── shell.json      required (metadata)
+├── launcher.exe    required (launches the shell)
+├── main.py         shell code (Python)
+└── assets/         wallpapers, cursors, sounds
+    ├── wallpaper.jpg
+    └── startup.wav
+```
+
+### shell.json
+
+```json
+{
+    "key": "win98",
+    "name": "Windows 98",
+    "version": "1.0.0",
+    "author": "dteamcorporation",
+    "description": "Classic Windows 98 interface",
+    "launcher": "launcher.exe",
+    "entry": "main.py"
+}
+```
+
+## Exclusions
+
+The following are skipped during packing:
+
+Files:
+
+`app.py`, `bot.py`, `server.py`, `emergency.py`, `pack_uifw.py`, `submit_app.py`, `unpack_uifw.py`, `shell_manager_app.py`, `launcher_standalone.py`, `launcher.pyw`, `firmware.db`, `requests.db`, `emergency.log`, `pack_uifw.exe`, `unpack_uifw.exe`
+
+Extensions:
+
+`.db`, `.log`, `.pyc`
+
+Directories:
+
+`cache`, `__pycache__`, `installed_shells`, `.git`, `.idea`, `.vscode`
+
+## Development
+
+```bash
+git clone https://github.com/k4024963-lang/packuifw.git
+cd packuifw
+pip install -e .
+```
+
+## License
+
+MIT © fa_creepyr
+
+## Links
+
+- Firmware Authority: [firmware.authority.cloudpub.ru](https://firmware.authority.cloudpub.ru)
+- TikTok: [@dteamcorporation](https://tiktok.com/@dteamcorporation)

packuifw-1.0.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+pack_uifw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pack_uifw/pack_uifw.py,sha256=MLnhe5CL8jyApX-e8p2Ag8sCEpoanGiUKM4S28rrr1M,3827
+packuifw-1.0.0.dist-info/METADATA,sha256=zZmJpoTJPTa8TGng_3BNB4ZrZvupmJbYjdeci_O3Quk,2546
+packuifw-1.0.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+packuifw-1.0.0.dist-info/entry_points.txt,sha256=cPSxz-nEQHVWs5Z6KQkK8ZD6CE1xl_HMj9gsyce8nF0,50
+packuifw-1.0.0.dist-info/top_level.txt,sha256=ZbsoMJyWmjmFc9yxWW3mbyu3XvYZYCClzxalypGIgyU,10
+packuifw-1.0.0.dist-info/RECORD,,

packuifw-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

packuifw-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pack_uifw = pack_uifw.main:main

packuifw-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pack_uifw