Merge pull request #26 from Cyber-Syntax:refactor/design-pattern

Refactor/design pattern

Author: Cyber-Syntax

.github/copilot-instructions.md

@@ -0,0 +1,17 @@
+# Python Coding Rules
+
+- Always add comments.
+- Follow PEP 8 style guidelines for code formatting.
+- Use meaningful variable and function names in snake_case.
+- Use UPPER_CASE for constants.
+- Use CamelCase for class names.
+- Add docstrings to all functions, classes, and modules following the Google style guide.
+- Use type hints to indicate parameter and return types.
+- Use f-strings for string formatting instead of older methods.
+- Implement proper exception handling with specific exception types.
+- Use logging instead of print statements for recording key actions and errors.
+- Store configuration in separate files (e.g., YAML, JSON, or .env) rather than hardcoding in scripts.
+- Always check return values from functions that may fail.
+- Write descriptive error messages that help diagnose the problem.
+- Keep functions focused on a single responsibility.
+- Use proper scoping for variables (avoid globals).

.github/workflows/main.yml

@@ -0,0 +1,74 @@
+name: Create Release from CHANGELOG
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "CHANGELOG.md" # Only trigger when CHANGELOG.md is updated
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Extract latest version and notes
+        id: changelog
+        run: |
+          # Extract the first version number from CHANGELOG.md
+          VERSION=$(grep -m 1 '^## v' CHANGELOG.md | sed 's/^## \(v[0-9.]*[0-9]\(-[a-zA-Z0-9]*\)*\).*/\1/')
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+          # Extract notes for this version (everything between this version header and the next version header)
+          NOTES=$(awk -v ver="$VERSION" '
+            BEGIN { found=0; capture=0; notes=""; }
+            $0 ~ "^## " ver { found=1; capture=1; next; }
+            $0 ~ /^## v/ && capture==1 { capture=0; }
+            capture==1 { notes = notes $0 "\n"; }
+            END { print notes; }
+          ' CHANGELOG.md)
+
+          # Save notes to output with correct GitHub multiline syntax
+          EOF=$(dd if=/dev/urandom bs=15 count=1 status=none | base64)
+          echo "notes<<$EOF" >> $GITHUB_OUTPUT
+          echo "$NOTES" >> $GITHUB_OUTPUT
+          echo "$EOF" >> $GITHUB_OUTPUT
+
+          # For debugging
+          echo "Found version: $VERSION"
+          echo "Release notes excerpt: $(echo "$NOTES" | head -3)..."
+
+      - name: Check for existing release
+        id: check_release
+        run: |
+          VERSION=${{ steps.changelog.outputs.version }}
+          if gh release view $VERSION &>/dev/null; then
+            echo "Release already exists: $VERSION"
+            echo "exists=true" >> $GITHUB_OUTPUT
+          else
+            echo "No existing release found for: $VERSION"
+            echo "exists=false" >> $GITHUB_OUTPUT
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Create zip archive
+        if: steps.check_release.outputs.exists == 'false'
+        run: zip -r AutoTarCompress-${{ steps.changelog.outputs.version }}.zip ./ -x "*.git*" ".github/*"
+
+      - name: Create GitHub Release
+        if: steps.check_release.outputs.exists == 'false'
+        uses: softprops/action-gh-release@v1
+        with:
+          tag_name: ${{ steps.changelog.outputs.version }}
+          name: "Release ${{ steps.changelog.outputs.version }}"
+          body: ${{ steps.changelog.outputs.notes }}
+          draft: false
+          prerelease: ${{ contains(steps.changelog.outputs.version, '-') }}
+          files: AutoTarCompress-${{ steps.changelog.outputs.version }}.zip
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -135,5 +135,5 @@ dmypy.json
 # vscode
 .vscode/
 
-# dirs_to_backup
-dirs_to_backup*
+# ruff
+.ruff_cache

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## v0.3.1-beta
+### Changes
+# BREAKING CHANGES
+Current config file location moved to `~/.config/autotarcompress/config.json`. Please review example config file and update it for your needs.
+  
+  - feat!: Use XDG Base Directory specifications.
+  - fix: endless backup command issue
+  - refactor: make class for context manager
+  - chore: format fix
+  - chore: pytproject.toml and requirements.txt update
+  - refactor!: add command design pattern

README.md

@@ -51,23 +51,25 @@
    ```
 
 5. Config File Handling:
-   - To customize your backup settings, you can use a `config.json` file. This file allows you to specify:
-      - Backup folder location, Directories to back up, Directories to ignore, Number of tar.xz and tar.xz.enc files to keep
+
+   - To customize your backup settings, you need to use a `config.json` file. This file allows you to specify:
+     - Backup folder location, Directories to back up, Directories to ignore, Number of tar.xz and tar.xz.enc files to keep
    - **Creating a Config File:**
      - You have two options:
-         1. **Run the script and follow the on-screen instructions**. This will guide you through creating a `config.json` file.
-         2. **Use an example config file (Optional)**:
-            - Copy the example configuration from `config_files_example/config.json`
-            - Paste it into your `backup_folder/config_files/config.json` location (e.g `~/Documents/backup-for-cloud/config_files/config.json`)
-            - Modify it as needed
+       1. **Use an example config file (Recommended)**:
+          - Copy the example configuration from `config_files_example/config.json`
+          - Paste it into your `~/Documents/project_configs/AutoTarCompress/config_files/config.json` location
+          - Modify it as needed
+       2. **Run the script and follow the on-screen instructions**.
+          - This will guide you through creating a `config.json` file.
 
-3. Start the script:
+6. Start the script:
 
    ```bash
    python3 main.py
    ```
 
-4. Follow the on-screen instructions.
+7. Follow the on-screen instructions.
 
 ---
 

README.tr.md

@@ -58,7 +58,7 @@
          1. **Senaryoyu çalıştır ve ekrandaki talimatları takip et**. Bu size bir `config.json` dosyası oluşturmayı kılavuzlayacaktır.
          2. **Örnek Ayar Dosyasını Kullan (Opsiyonel)**:
             - Örnek konfigürasyonunuzu `config_files_example/config.json` konumundan kopyalayın
-            - Bu dosyayı `backup_folder/config_files/config.json` konumuna yapıştırın (örn. `~/Documents/backup-for-cloud/config_files/config.json`)
+            - Bu dosyayı `~/.config/autotarcompress/config.json` konumuna yapıştırın (örn. `~/Documents/backup-for-cloud/config_files/config.json`)
             - Gereksinim duyduğunuz kadarını değiştirin
 
 3. Script'i başlatın:

TODO.md

@@ -0,0 +1,25 @@
+{
+  "backup_folder": "~/Documents/backup-for-cloud/",
+  "config_dir": "~/.config/autotarcompress",
+  "keep_backup": 1,
+  "keep_enc_backup": 1,
+  "dirs_to_backup": [
+    "~/Pictures",
+    "~/Documents",
+    "~/.config/autotarcompress",
+    "~/.mozilla/firefox/sqwu9kep.default-release",
+    "~/.config/BraveSoftware/Brave-Browser/Default",
+    "~/dotfiles",
+    "~/bare"
+  ],
+  "ignore_list": [
+    "~/Documents/appimages",
+    "~/Documents/backup-for-cloud",
+    "~/Documents/.stversions",
+    "node_modules",
+    ".venv",
+    "__pycache__",
+    ".ruff_cache"
+  ],
+  "last_backup": null
+}