distroscript 0.1.0__tar.gz → 0.2.1__tar.gz

{distroscript-0.1.0 → distroscript-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: distroscript
-Version: 0.1.0
+Version: 0.2.1
 Summary: Generate Bash installation scripts from a declarative YAML config for multiple Linux distros
 Project-URL: Homepage, https://github.com/RaniAgus/distroscript
 Project-URL: Repository, https://github.com/RaniAgus/distroscript
@@ -36,6 +36,10 @@ License-File: LICENSE
 Requires-Python: >=3.10
 Requires-Dist: jsonschema
 Requires-Dist: pyyaml
+Provides-Extra: dev
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: types-jsonschema; extra == 'dev'
+Requires-Dist: types-pyyaml; extra == 'dev'
 Description-Content-Type: text/markdown
 
 # distroscript
@@ -44,7 +48,7 @@ Generate installation scripts for various Linux distributions based on a
 declarative YAML configuration file.
 
 ```txt
-distroscript.py [-h] --os OS [--out OUT] config_path
+distroscript [-h] --os OS [--out OUT] config_path
 
 Generate installation scripts from YAML config.
 
@@ -61,18 +65,18 @@ options:
 > For now, only `fedora` is fully supported, but I plan to add support for
 > `ubuntu`, `popos` and `mint` in the future.
 
-## Dependencies
-
-- Ubuntu / Debian
+## Installation
 
 ```bash
-sudo apt-get install python3 python3-pyyaml python3-jsonschema
+pip install distroscript
 ```
 
-- Fedora / Red Hat / CentOS
+## Development
+
+Install dev dependencies with:
 
 ```bash
-sudo dnf install python3 python3-pyyaml python3-jsonschema
+pip install -e ".[dev]"
 ```
 
 - MacOS
@@ -83,10 +87,10 @@ brew install python3 pyyaml jsonschema
 
 ## Schema Validation
 
-The configuration files are validated against a JSON Schema specification (`src/schema.json`) 
+The configuration files are validated against a JSON Schema specification (`src/schema.json`)
 that defines the structure and constraints for all supported package types and their properties.
 
-The validation happens automatically after reading the YAML file and before processing begins. 
+The validation happens automatically after reading the YAML file and before processing begins.
 If validation fails, the script will exit with a detailed error message showing:
 - The path to the invalid field
 - A description of what's wrong
@@ -405,21 +409,26 @@ oh-my-zsh:
 **AppImage:**
 
 ```yaml
-duckstation:
+obsidian:
   - type: appimage
-    url: https://github.com/stenzek/duckstation/releases/download/latest/DuckStation-x64.AppImage
-    name: DuckStation
-    icon_name: org.duckstation.DuckStation
-    categories:
-      - Game
-      - Emulator
+    url: https://github.com/obsidianmd/obsidian-releases/releases/download/v1.8.10/Obsidian-1.8.10.AppImage
+    name: Obsidian
+    icon_name: obsidian
+    mime_types:
+      - x-scheme-handler/obsidian
+      - type: text/markdown
+        default: true
 ```
 
 AppImages are downloaded to `$HOME/.local/bin/`, a desktop entry is created in
 `$HOME/.local/share/applications/`, and icons are extracted automatically when `icon_name` is specified.
 
+When `mime_types` is provided, the desktop entry advertises those MIME types. If `default` is not set, only scheme
+handler strings register the AppImage as their default handler, other MIME types will not be set as default unless
+`default: true` is explicitly specified.
+
 > [!NOTE]
-> AppImage packages require the `url` field. The `name`, `icon_name`, and `categories` fields are optional.
+> AppImage packages require the `url` field. The `name`, `icon_name`, `categories`, and `mime_types` fields are optional.
 > The `name` field defaults to the package name, `icon_name` enables desktop icon extraction when provided,
 > and `categories` defaults to "Application".
 

{distroscript-0.1.0 → distroscript-0.2.1}/README.md

@@ -4,7 +4,7 @@ Generate installation scripts for various Linux distributions based on a
 declarative YAML configuration file.
 
 ```txt
-distroscript.py [-h] --os OS [--out OUT] config_path
+distroscript [-h] --os OS [--out OUT] config_path
 
 Generate installation scripts from YAML config.
 
@@ -21,18 +21,18 @@ options:
 > For now, only `fedora` is fully supported, but I plan to add support for
 > `ubuntu`, `popos` and `mint` in the future.
 
-## Dependencies
-
-- Ubuntu / Debian
+## Installation
 
 ```bash
-sudo apt-get install python3 python3-pyyaml python3-jsonschema
+pip install distroscript
 ```
 
-- Fedora / Red Hat / CentOS
+## Development
+
+Install dev dependencies with:
 
 ```bash
-sudo dnf install python3 python3-pyyaml python3-jsonschema
+pip install -e ".[dev]"
 ```
 
 - MacOS
@@ -43,10 +43,10 @@ brew install python3 pyyaml jsonschema
 
 ## Schema Validation
 
-The configuration files are validated against a JSON Schema specification (`src/schema.json`) 
+The configuration files are validated against a JSON Schema specification (`src/schema.json`)
 that defines the structure and constraints for all supported package types and their properties.
 
-The validation happens automatically after reading the YAML file and before processing begins. 
+The validation happens automatically after reading the YAML file and before processing begins.
 If validation fails, the script will exit with a detailed error message showing:
 - The path to the invalid field
 - A description of what's wrong
@@ -365,21 +365,26 @@ oh-my-zsh:
 **AppImage:**
 
 ```yaml
-duckstation:
+obsidian:
   - type: appimage
-    url: https://github.com/stenzek/duckstation/releases/download/latest/DuckStation-x64.AppImage
-    name: DuckStation
-    icon_name: org.duckstation.DuckStation
-    categories:
-      - Game
-      - Emulator
+    url: https://github.com/obsidianmd/obsidian-releases/releases/download/v1.8.10/Obsidian-1.8.10.AppImage
+    name: Obsidian
+    icon_name: obsidian
+    mime_types:
+      - x-scheme-handler/obsidian
+      - type: text/markdown
+        default: true
 ```
 
 AppImages are downloaded to `$HOME/.local/bin/`, a desktop entry is created in
 `$HOME/.local/share/applications/`, and icons are extracted automatically when `icon_name` is specified.
 
+When `mime_types` is provided, the desktop entry advertises those MIME types. If `default` is not set, only scheme
+handler strings register the AppImage as their default handler, other MIME types will not be set as default unless
+`default: true` is explicitly specified.
+
 > [!NOTE]
-> AppImage packages require the `url` field. The `name`, `icon_name`, and `categories` fields are optional.
+> AppImage packages require the `url` field. The `name`, `icon_name`, `categories`, and `mime_types` fields are optional.
 > The `name` field defaults to the package name, `icon_name` enables desktop icon extraction when provided,
 > and `categories` defaults to "Application".
 

{distroscript-0.1.0 → distroscript-0.2.1}/pyproject.toml

@@ -14,6 +14,13 @@ dependencies = [
     "jsonschema",
 ]
 
+[project.optional-dependencies]
+dev = [
+    "mypy",
+    "types-pyyaml",
+    "types-jsonschema",
+]
+
 [project.scripts]
 distroscript = "distroscript:_cli"
 

{distroscript-0.1.0 → distroscript-0.2.1}/src/distroscript.py

@@ -16,10 +16,10 @@ import json
 from jsonschema import validate, ValidationError
 import os
 import sys
-from typing import ClassVar, Generic, TypeVar
+from typing import ClassVar, Generic, TypeVar, TypedDict
 import yaml
 
-__version__ = "0.1.0"
+__version__ = "0.2.1"
 
 def main(args: argparse.Namespace) -> None:
     """
@@ -189,6 +189,11 @@ PLATFORMS = {
 
 T = TypeVar('T', bound='Package')
 
+
+class MimeType(TypedDict):
+    type: str
+    default: bool
+
 @dataclass(frozen=True)
 class Package(ABC, Generic[T]):
     factories: ClassVar[dict[str, type[Package]]] = {}
@@ -863,6 +868,20 @@ class AppImagePackage(Package, type='appimage'):
     def create(cls, name: str, item: dict, platform: Platform) -> list[Package]:
         url = item.get('url')
         icon_name = item.get('icon_name')
+        mime_types: list[MimeType] = []
+        for mime_type in item.get('mime_types', []):
+            if isinstance(mime_type, str):
+                mime_types.append({
+                    'type': mime_type,
+                    'default': mime_type.startswith('x-scheme-handler/'),
+                })
+            else:
+                mime_type_name = mime_type.get('type')
+                mime_types.append({
+                    'type': mime_type_name,
+                    'default': mime_type.get('default', mime_type_name.startswith('x-scheme-handler/')),
+                })
+        mime_type_names = [mime_type['type'] for mime_type in mime_types]
 
         if not url:
             raise RuntimeError(f"AppImagePackage requires 'url' field.")
@@ -876,6 +895,10 @@ class AppImagePackage(Package, type='appimage'):
         # Set up post_install commands for desktop integration
         app_name = item.get('name', name)
         destination = f"$HOME/.local/bin/{app_name}.AppImage"
+        desktop_file = f"{app_name}.desktop"
+        categories = item.get('categories', 'Application')
+        if isinstance(categories, str):
+            categories = [categories]
 
         # Desktop file creation
         desktop_entry = []
@@ -884,20 +907,30 @@ class AppImagePackage(Package, type='appimage'):
         desktop_entry.append('StartupNotify=true')
         desktop_entry.append('Type=Application')
         desktop_entry.append('Terminal=false')
-        desktop_entry.append(f'Categories={";".join(item.get('categories', 'Application'))};')
+        desktop_entry.append(f'Categories={";".join(categories)};')
         if icon_name:
             desktop_entry.append(f'Icon={icon_name}')
-        desktop_entry.append(f'Exec=sh -c "{destination}"')
+        if mime_type_names:
+            desktop_entry.append(f'MimeType={";".join(mime_type_names)};')
+        desktop_entry.append(f'Exec=sh -c \'"{destination}" "$1"\' sh %u')
         desktop_entry.append('')
 
         post_install.append(
             TeeCommand(
                 '\n'.join(desktop_entry),
-                destination=f"$HOME/.local/share/applications/{app_name}.desktop",
+                destination=f"$HOME/.local/share/applications/{desktop_file}",
                 mkdir=True,
             )
         )
 
+        for mime_type in mime_types:
+            if mime_type.get('default', False):
+                post_install.append(
+                    ShellCommand(
+                        command=f'xdg-mime default {desktop_file} {mime_type["type"]}'
+                    )
+                )
+
         # Icon extraction if icon_name is provided
         if icon_name:
             extract_icons = []

{distroscript-0.1.0 → distroscript-0.2.1}/src/schema.json

@@ -544,6 +544,29 @@
             }
           ]
         },
+        "mime_types": {
+          "type": "array",
+          "items": {
+            "oneOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "object",
+                "required": ["type"],
+                "properties": {
+                  "type": {
+                    "type": "string"
+                  },
+                  "default": {
+                    "type": "boolean"
+                  }
+                },
+                "additionalProperties": false
+              }
+            ]
+          }
+        },
         "depends_on": {
           "$ref": "#/definitions/dependencyList"
         },

distroscript-0.2.1/tests/inputs/17-appimage.yml

@@ -0,0 +1,26 @@
+appimage:
+  - type: dnf
+    packages: [fuse, fuse-libs]
+  - type: apt
+    packages: [fuse, libfuse2]
+
+duckstation:
+  - type: appimage
+    url: https://github.com/stenzek/duckstation/releases/download/latest/DuckStation-x64.AppImage
+    name: DuckStation
+    icon_name: org.duckstation.DuckStation
+    categories:
+      - Game
+      - Emulator
+
+obsidian:
+  - type: appimage
+    url: https://github.com/obsidianmd/obsidian-releases/releases/download/v1.8.10/Obsidian-1.8.10.AppImage
+    name: Obsidian
+    mime_types:
+      - x-scheme-handler/obsidian
+      - application/x-obsidian-vault
+      - type: text/markdown
+        default: true
+      - type: x-scheme-handler/obsidian-dev
+        default: false

{distroscript-0.1.0 → distroscript-0.2.1}/tests/outputs/fedora/17-appimage.sh

@@ -29,7 +29,7 @@ Type=Application
 Terminal=false
 Categories=Game;Emulator;
 Icon=org.duckstation.DuckStation
-Exec=sh -c "$HOME/.local/bin/DuckStation.AppImage"
+Exec=sh -c '"$HOME/.local/bin/DuckStation.AppImage" "$1"' sh %u
 EOF
 
 (
@@ -39,3 +39,23 @@ EOF
   cp -rv squashfs-root/usr/share/icons/hicolor/* "$HOME/.local/share/icons/hicolor/" 2>/dev/null || true
   rm -rf "$TMP_DIR"
 )
+
+mkdir -p "$(dirname "$HOME/.local/bin/Obsidian.AppImage")"
+curl -fsSL "https://github.com/obsidianmd/obsidian-releases/releases/download/v1.8.10/Obsidian-1.8.10.AppImage" -o "$HOME/.local/bin/Obsidian.AppImage" > /dev/null
+chmod +x "$HOME/.local/bin/Obsidian.AppImage"
+
+mkdir -p "$(dirname "$HOME/.local/share/applications/Obsidian.desktop")"
+tee "$HOME/.local/share/applications/Obsidian.desktop" <<'EOF'
+[Desktop Entry]
+Name=Obsidian
+StartupNotify=true
+Type=Application
+Terminal=false
+Categories=Application;
+MimeType=x-scheme-handler/obsidian;application/x-obsidian-vault;text/markdown;x-scheme-handler/obsidian-dev;
+Exec=sh -c '"$HOME/.local/bin/Obsidian.AppImage" "$1"' sh %u
+EOF
+
+xdg-mime default Obsidian.desktop x-scheme-handler/obsidian
+
+xdg-mime default Obsidian.desktop text/markdown

{distroscript-0.1.0 → distroscript-0.2.1}/tests/outputs/ubuntu/17-appimage.sh

@@ -29,7 +29,7 @@ Type=Application
 Terminal=false
 Categories=Game;Emulator;
 Icon=org.duckstation.DuckStation
-Exec=sh -c "$HOME/.local/bin/DuckStation.AppImage"
+Exec=sh -c '"$HOME/.local/bin/DuckStation.AppImage" "$1"' sh %u
 EOF
 
 (
@@ -39,3 +39,23 @@ EOF
   cp -rv squashfs-root/usr/share/icons/hicolor/* "$HOME/.local/share/icons/hicolor/" 2>/dev/null || true
   rm -rf "$TMP_DIR"
 )
+
+mkdir -p "$(dirname "$HOME/.local/bin/Obsidian.AppImage")"
+curl -fsSL "https://github.com/obsidianmd/obsidian-releases/releases/download/v1.8.10/Obsidian-1.8.10.AppImage" -o "$HOME/.local/bin/Obsidian.AppImage" > /dev/null
+chmod +x "$HOME/.local/bin/Obsidian.AppImage"
+
+mkdir -p "$(dirname "$HOME/.local/share/applications/Obsidian.desktop")"
+tee "$HOME/.local/share/applications/Obsidian.desktop" <<'EOF'
+[Desktop Entry]
+Name=Obsidian
+StartupNotify=true
+Type=Application
+Terminal=false
+Categories=Application;
+MimeType=x-scheme-handler/obsidian;application/x-obsidian-vault;text/markdown;x-scheme-handler/obsidian-dev;
+Exec=sh -c '"$HOME/.local/bin/Obsidian.AppImage" "$1"' sh %u
+EOF
+
+xdg-mime default Obsidian.desktop x-scheme-handler/obsidian
+
+xdg-mime default Obsidian.desktop text/markdown

distroscript-0.1.0/tests/inputs/17-appimage.yml

@@ -1,14 +0,0 @@
-appimage:
-  - type: dnf
-    packages: [fuse, fuse-libs]
-  - type: apt
-    packages: [fuse, libfuse2]
-
-duckstation:
-  - type: appimage
-    url: https://github.com/stenzek/duckstation/releases/download/latest/DuckStation-x64.AppImage
-    name: DuckStation
-    icon_name: org.duckstation.DuckStation
-    categories:
-      - Game
-      - Emulator