Merge remote-tracking branch 'origin/main' into feat/apps

Author: Cyber-Syntax

AGENTS.md

@@ -0,0 +1,31 @@
+# AGENTS.md
+
+This file provides guidance to agents when working with code in this repository.
+
+## General Guidelines
+
+1. Modern Python First: Use Python 3.12+ features extensively - built-in generics, pattern matching, and dataclasses.
+2. KISS Principle: Aim for simplicity and clarity. Avoid unnecessary abstractions or metaprogramming.
+3. DRY with Care: Reuse code appropriately but avoid over-engineering. Each command handler has single responsibility.
+
+## Test after any change
+
+1. Activate venv before any test execution:
+
+```bash
+source .venv/bin/activate
+```
+
+2. Run pytest with following command to ensure all tests pass:
+
+```bash
+pytest -v -q --strict-markers
+```
+
+## Run the application
+
+```bash
+python run.py --help
+python run.py install appflowy
+python run.py update appflowy
+```

CHANGELOG.md

@@ -1,6 +1,33 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## v1.8.0-alpha
+### BREAKING CHANGES
+This release removes the `self-update` command to use `upgrade` command instead for better clarity and consistency. Also, upgrade command now removed the rich progress bar and use simple text-based progress updates to improve performance and reduce resource consumption.
+
+### Migration guide
+Please update manually with setup.sh script. Run the following commands in your terminal:
+
+```bash
+git clone https://github.com/Cyber-Syntax/my-unicorn.git
+cd my-unicorn
+./setup.sh
+```
+
+## v1.7.4-alpha
+## v1.7.3-alpha
+## v1.7.2-alpha
+## v1.7.1-alpha
+## v1.7.0-alpha
+# CHANGES
+This release refactors the codebase for improved code readability, maintainability and performance.
+
+- Removed size verification logic which it was not best practice to verify app integrity.
+
+## v1.6.0-alpha
+# BREAKING CHANGES
+This release introduces a comprehensive caching mechanism for GitHub release data, enhancing performance and reducing redundant API calls. The caching system is designed to store release information persistently, with a configurable time-to-live (TTL) to ensure data freshness. Additionally, the release includes significant improvements to the logging capabilities of the verification service, providing detailed insights into the verification process and asset handling.
+
 ## v1.5.1-alpha
 ## v1.5.0-alpha
 # BREAKING CHANGES

README.md

@@ -1,26 +1,24 @@
-Türkçe Açıklama: [README.tr.md](README.tr.md)
+Turkish: [README.tr.md](README.tr.md)
 
 > [!CAUTION]
-> This project is in a **alpha phase** due to limited testing at this time.
 >
-> **Important:** Follow the instructions in the **Releases section** when updating the script.
->
-> **Supported OS:** Currently, only Linux is supported.
+> - This project is in a **alpha phase** due to limited testing at this time.
+> - **Important:** Follow the instructions in the **Releases section** when updating the script.
+> - **Supported OS:** Currently, only Linux is supported.
 
 # **🦄 About my-unicorn**
 
 > [!NOTE]
-> I always frustrated with the manual AppImage update process and I created this project to automate the process.
+> My Unicorn is a command-line tool to manage AppImages on Linux. It allows users to install, update, and manage AppImages from GitHub repositories easily. It's designed to simplify the process of handling AppImages, making it more convenient for users to keep their applications up-to-date.
 >
-> This project introduces a Python-based CLI tool that treats AppImages like packages: installable, updatable,
-> and manageable via a simple interface.
-> Detailed information: [wiki.md](docs/wiki.md)
+> - Detailed information: [wiki.md](docs/wiki.md)
 
 - **Supported Applications:**
-    - Super-Productivity, Siyuan, Joplin, Standard-notes, Logseq, QOwnNotes, Tagspaces, Zen-Browser, weektodo, Zettlr, HeroicGamesLauncher, KDiskMark, AppFlowy, Obsidian
+    - Super-Productivity, Siyuan, Joplin, Standard-notes, Logseq, QOwnNotes, Tagspaces, Zen-Browser, Zettlr, HeroicGamesLauncher, KDiskMark, AppFlowy, Obsidian
     - Applications without verification (developer doesn't provide hash):
+        - WeekToDo
         - FreeTube
-            - Related issue: https://github.com/FreeTubeApp/FreeTube/issues/4720)
+            - Related issue: <https://github.com/FreeTubeApp/FreeTube/issues/4720>)
     - More can be found in the [catalog](my_unicorn/catalog/) folder.
 - **Supported hash types:**
     - sha256, sha512
@@ -41,16 +39,27 @@ Türkçe Açıklama: [README.tr.md](README.tr.md)
 
     ```bash
     cd my-unicorn &
-    sh my-unicorn-installer.sh install
+    sh setup.sh install
+    ```
+
+3. Add autocomplete (optional):
+
+    ```bash
+    # auto-detect your shell and install autocomplete
+    sh setup.sh autocomplete
+
+    # or manually add autocomplete for bash or zsh
+    sh setup.sh autocomplete bash
+    sh setup.sh autocomplete zsh
     ```
 
-3. Start using my-unicorn:
+4. Start using my-unicorn:
 
     ```bash
     my-unicorn --help # to see the command options
     ```
 
-## For using uncompatible apps (installing with URL):
+## For using uncompatible apps (installing with URL)
 
 > [!IMPORTANT]
 > If you want to install an uncompatible app, you'll need to know some information about the application.

README.tr.md

@@ -1,7 +1,7 @@
 English Description: [README.md](README.md)
 
 > [!CAUTION]
-> Bu proje sınırlı testlerden dolayı şu anlık **alpha aşamasındadır**. 
+> Bu proje sınırlı testlerden dolayı şu anlık **alpha aşamasındadır**.
 >
 > **Önemli:** Script’i güncellerken **Releases** bölümündeki talimatları takip edin.
 >
@@ -10,15 +10,15 @@ English Description: [README.md](README.md)
 ## **🦄 my-unicorn Hakkında**
 
 > [!NOTE]
-> Manuel AppImage güncelleme sürecinden yılmıştım, süreci otomatikleştirmek için bu projeyi oluşturdum. 
+> Manuel AppImage güncelleme sürecinden yılmıştım, süreci otomatikleştirmek için bu projeyi oluşturdum.
 >
-> Detaylı bilgi: [wiki.md](docs/wiki.md) 
+> Detaylı bilgi: [wiki.md](docs/wiki.md)
 
 - **Desteklenen Uygulamalar:**
     - Super-Productivity, Siyuan, Joplin, Standard-notes, Logseq, QOwnNotes, Tagspaces, Zen-Browser, weektodo, Zettlr
     - Doğrulaması olmayan uygulamalar (yazılımcıları hash sağlamıyor):
         - FreeTube
-            - Bağlantılı sorun: https://github.com/FreeTubeApp/FreeTube/issues/4720)
+            - Bağlantılı sorun: <https://github.com/FreeTubeApp/FreeTube/issues/4720>)
         - AppFlowy
         - Obsidian
     - Daha fazlası [apps](my_unicorn/apps/) klasöründe bulunabilir.
@@ -41,10 +41,10 @@ English Description: [README.md](README.md)
 
     ```bash
     cd my-unicorn &
-    sh my-unicorn-installer.sh install
+    sh setup.sh install
     ```
-    
-## Paketi kaldır:
+
+## Paketi kaldır
 
 > [!TIP]
 > Eğer paketi küresel olarak yüklediyseniz, aşağıdaki komutu kullanarak kaldırabilirsiniz:
@@ -55,7 +55,7 @@ English Description: [README.md](README.md)
 
 # Nasıl Kullanılır?
 
-## Paket olarak kullanım:
+## Paket olarak kullanım
 
 ```bash
 my-unicorn --help # to see the command options
@@ -91,25 +91,24 @@ my-unicorn migrate --clean # Migrate configuration files
 my-unicorn migrate --force # Migrate configuration without confirmation
 ```
 
-
-## Desteklenmeyen uygulamalar için (URL ile kurulum):
+## Desteklenmeyen uygulamalar için (URL ile kurulum)
 
 > [!IMPORTANT]
 > Eğer desteklenmeyen bir uygulamayı kurmak istiyorsanız, uygulama hakkında bazı bilgilere sahip olmanız gerekecektir.
 
 - **GitHub URL:** Uygulamanın GitHub depo adresi (örn. `https://github.com/johannesjo/super-productivity`).
 - Hash türü ve Hash dosya adı otamatik olarak tespit edilir. Eğer uygulamanın uyumluluğu yoksa veya hata oluşursa aşağıdaki bilgileri sağlamanız gerekecek:
-   - **Hash türü:** Hash türünü belirtin (örn. super-productivity için sha512).
-   - **Hash doğrulama sorunları:** Eğer hash doğrulama başarısız olursa, hash'i manuel olarak JSON dosyasına ekleyebilirsiniz:
-     - En son hash bilgisini GitHub sürüm sayfasında bulabilirsiniz (örn. [super-productivity releases](https://github.com/johannesjo/super-productivity/releases)).
-     - Örnekler için [apps](my_unicorn/apps/) klasörüne bakabilirsiniz.
+    - **Hash türü:** Hash türünü belirtin (örn. super-productivity için sha512).
+    - **Hash doğrulama sorunları:** Eğer hash doğrulama başarısız olursa, hash'i manuel olarak JSON dosyasına ekleyebilirsiniz:
+        - En son hash bilgisini GitHub sürüm sayfasında bulabilirsiniz (örn. [super-productivity releases](https://github.com/johannesjo/super-productivity/releases)).
+        - Örnekler için [apps](my_unicorn/apps/) klasörüne bakabilirsiniz.
 
 # **🙏 Bu Projeye Destek Olun**
 
 - **GitHub üzerinde yıldız ⭐** vererek desteğinizi gösterebilirsiniz, böylece kodlama yolculuğumda motive olmamı sağlar!
 - **Test:** Eğer betiği test eder ve karşılaştığınız herhangi bir sorun hakkında geri bildirim sağlayabilirseniz harika olur.
 - **💖 Projeyi Destekle:** Çalışmalarımı desteklemek ve projeler yapmaya devam etmemi sağlamak istersen, bana sponsor olmayı düşünebilirsin:
-  - [![Sponsor Ol](https://img.shields.io/badge/Sponsor-💖-brightgreen)](https://github.com/sponsors/Cyber-Syntax)
+    - [![Sponsor Ol](https://img.shields.io/badge/Sponsor-💖-brightgreen)](https://github.com/sponsors/Cyber-Syntax)
 
 ## **🤝 Katkı Sağlama**
 

autocomplete/README.md

@@ -0,0 +1,3 @@
+# Completions
+
+This directory contains subdirectories for `my-unicorn`'s tab completions for `bash` and `zsh`.

autocomplete/bash_autocomplete

@@ -0,0 +1,121 @@
+#!/bin/bash
+
+# my-unicorn bash completion script
+# Source this file to enable tab completion for my-unicorn command
+
+_my_unicorn_completion() {
+    local cur prev commands
+    COMPREPLY=()
+    cur="${COMP_WORDS[COMP_CWORD]}"
+    prev="${COMP_WORDS[COMP_CWORD-1]}"
+    
+    # Available commands
+    commands="install update upgrade list remove backup cache auth config"
+    
+    # Global options
+    local global_opts="--help --version"
+    
+    # Command-specific options
+    local install_opts="--concurrency --no-icon --no-verify --no-desktop --verbose --help"
+    local update_opts="--check-only --refresh-cache --verbose --help"
+    local upgrade_opts="--check-only --help"
+    local list_opts="--available --help"
+    local remove_opts="--keep-config --help"
+    local backup_opts="--restore-last --restore-version --list-backups --cleanup --info --migrate --help"
+    local cache_opts="clear stats --help"
+    local cache_clear_opts="--all --help"
+    local auth_opts="--save-token --remove-token --status --help"
+    local config_opts="--show --reset --help"
+    
+    # If we're completing the first argument (command)
+    if [[ ${COMP_CWORD} -eq 1 ]]; then
+        mapfile -t COMPREPLY < <(compgen -W "${commands} ${global_opts}" -- "${cur}")
+        return 0
+    fi
+    
+    # Get the command being used
+    local command="${COMP_WORDS[1]}"
+    
+    case "${command}" in
+        install)
+            case "${prev}" in
+                --concurrency)
+                    # Numeric value expected
+                    COMPREPLY=()
+                    ;;
+                *)
+                    if [[ ${cur} == -* ]]; then
+                        mapfile -t COMPREPLY < <(compgen -W "${install_opts}" -- "${cur}")
+                    else
+                        # Complete with app names or URLs
+                        COMPREPLY=()
+                    fi
+                    ;;
+            esac
+            ;;
+        update)
+            if [[ ${cur} == -* ]]; then
+                mapfile -t COMPREPLY < <(compgen -W "${update_opts}" -- "${cur}")
+            else
+                # Complete with installed app names
+                COMPREPLY=()
+            fi
+            ;;
+        upgrade)
+            mapfile -t COMPREPLY < <(compgen -W "${upgrade_opts}" -- "${cur}")
+            ;;
+        list)
+            mapfile -t COMPREPLY < <(compgen -W "${list_opts}" -- "${cur}")
+            ;;
+        remove)
+            if [[ ${cur} == -* ]]; then
+                mapfile -t COMPREPLY < <(compgen -W "${remove_opts}" -- "${cur}")
+            else
+                # Complete with installed app names
+                COMPREPLY=()
+            fi
+            ;;
+        backup)
+            case "${prev}" in
+                --restore-version)
+                    # Version string expected
+                    COMPREPLY=()
+                    ;;
+                *)
+                    if [[ ${cur} == -* ]]; then
+                        mapfile -t COMPREPLY < <(compgen -W "${backup_opts}" -- "${cur}")
+                    else
+                        # Complete with app names
+                        COMPREPLY=()
+                    fi
+                    ;;
+            esac
+            ;;
+        cache)
+            if [[ ${COMP_CWORD} -eq 2 ]]; then
+                mapfile -t COMPREPLY < <(compgen -W "${cache_opts}" -- "${cur}")
+            elif [[ ${COMP_WORDS[2]} == "clear" ]]; then
+                if [[ ${cur} == -* ]]; then
+                    mapfile -t COMPREPLY < <(compgen -W "${cache_clear_opts}" -- "${cur}")
+                else
+                    # Complete with app names
+                    COMPREPLY=()
+                fi
+            fi
+            ;;
+        auth)
+            mapfile -t COMPREPLY < <(compgen -W "${auth_opts}" -- "${cur}")
+            ;;
+        config)
+            mapfile -t COMPREPLY < <(compgen -W "${config_opts}" -- "${cur}")
+            ;;
+        *)
+            COMPREPLY=()
+            ;;
+    esac
+    
+    return 0
+}
+
+# Register the completion function
+complete -F _my_unicorn_completion my-unicorn