pyproject-appimage 3.0__tar.gz → 4.0__tar.gz

{pyproject-appimage-3.0/pyproject_appimage.egg-info → pyproject-appimage-4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyproject-appimage
-Version: 3.0
+Version: 4.0
 Summary: Generate AppImages from your Python projects
 Author-email: JakobDev <jakobdev@gmx.de>
 License: BSD-2-Clause
@@ -24,6 +24,9 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: desktop-entry-lib
+Requires-Dist: tomli; python_version < "3.11"
 
 # pyproject-appimage
 
@@ -56,11 +59,15 @@ The following options can be used in your pyproject.toml:
 | rename-icon | string | Give your Icon another name inside the AppImage |
 | desktop-entry | string | The path to your .desktop file |
 | rename-desktop-entry | string | Give your .desktop file another name inside the AppImage |
+| gettext-desktop-entry | bool | If your .desktop file should be translated using gettest |
 | appstream | string | The path to your AppStream file |
 | rename-appstream | string | Give your AppStream file another name inside the AppImage |
+| gettext-appstream | bool | If your AppStream file should be translated using gettest |
+| gettext-directory | string | The path to your gettext directory |
 | python-version | string | The Python version that is used. Default is your current version. Can be overwritten with the cli. |
 | updateinformation | string | The [update information](https://github.com/AppImage/AppImageSpec/blob/master/draft.md#update-information)
 | compression | string | The Squashfs compression
+| additional-packages | list of strins | A list of packages that should also be installed
 
 Note: All paths are relativ to your project directory
 
@@ -86,6 +93,9 @@ options:
   -v, --version         Prints the version and exit
 ```
 
+## Projects using pyproject-appimage
+* [jdNBTExplorer](https://codeberg.org/JakobDev/jdNBTExplorer)
+
 [pyproject-appimage is of course also available as AppImage](https://codeberg.org/JakobDev/pyproject-appimage/releases/latest)
 
 pyproject-appimage is based [on the work of niess](https://github.com/niess/python-appimage)

{pyproject-appimage-3.0 → pyproject-appimage-4.0}/README.md

@@ -29,11 +29,15 @@ The following options can be used in your pyproject.toml:
 | rename-icon | string | Give your Icon another name inside the AppImage |
 | desktop-entry | string | The path to your .desktop file |
 | rename-desktop-entry | string | Give your .desktop file another name inside the AppImage |
+| gettext-desktop-entry | bool | If your .desktop file should be translated using gettest |
 | appstream | string | The path to your AppStream file |
 | rename-appstream | string | Give your AppStream file another name inside the AppImage |
+| gettext-appstream | bool | If your AppStream file should be translated using gettest |
+| gettext-directory | string | The path to your gettext directory |
 | python-version | string | The Python version that is used. Default is your current version. Can be overwritten with the cli. |
 | updateinformation | string | The [update information](https://github.com/AppImage/AppImageSpec/blob/master/draft.md#update-information)
 | compression | string | The Squashfs compression
+| additional-packages | list of strins | A list of packages that should also be installed
 
 Note: All paths are relativ to your project directory
 
@@ -59,6 +63,9 @@ options:
   -v, --version         Prints the version and exit
 ```
 
+## Projects using pyproject-appimage
+* [jdNBTExplorer](https://codeberg.org/JakobDev/jdNBTExplorer)
+
 [pyproject-appimage is of course also available as AppImage](https://codeberg.org/JakobDev/pyproject-appimage/releases/latest)
 
 pyproject-appimage is based [on the work of niess](https://github.com/niess/python-appimage)

{pyproject-appimage-3.0 → pyproject-appimage-4.0}/pyproject.toml

@@ -28,26 +28,30 @@ classifiers = [
 ]
 dependencies = [
     "requests",
+    "desktop-entry-lib",
     "tomli; python_version < '3.11'"
 ]
 dynamic = ["version"]
 
-[tool.setuptools.dynamic]
-version = { file = "pyproject_appimage/version.txt" }
-
-[project.scripts]
-pyproject-appimage = "pyproject_appimage:main"
-
-[tool.setuptools.package-data]
-pyproject_appimage = ["version.txt", "default.png", "default.desktop"]
-
 [project.urls]
 Downloads = "https://codeberg.org/JakobDev/pyproject-appimage/releases"
 Issues = "https://codeberg.org/JakobDev/pyproject-appimage/issues"
 Source = "https://codeberg.org/JakobDev/pyproject-appimage"
 Donation = "https://ko-fi.com/jakobdev"
 
+[tool.setuptools.package-dir]
+pyproject_appimage = "pyproject_appimage"
+
+[tool.setuptools.dynamic]
+version = { file = "pyproject_appimage/version.txt" }
+
+[tool.setuptools.package-data]
+pyproject_appimage = ["version.txt", "default.png"]
+
+[project.scripts]
+pyproject-appimage = "pyproject_appimage:main"
+
 [tool.pyproject-appimage]
 script = "pyproject-appimage"
 output = "pyproject-appimage.AppImage"
-python-version ="3.11"
+python-version ="3.12"

{pyproject-appimage-3.0 → pyproject-appimage-4.0}/pyproject_appimage/__init__.py

@@ -1,4 +1,5 @@
 from typing import Optional, Any, TypedDict
+import desktop_entry_lib
 import subprocess
 import argparse
 import requests
@@ -34,6 +35,18 @@ PyprojectDict = TypedDict("PyprojectDict", {
 }, total=False)
 
 
+def read_pyproject_file(path: str) -> dict[str, Any]:
+    with open(path, "rb") as f:
+        try:
+            return toml_load(f)
+        except Exception as ex:
+            if len(ex.args) == 1:
+                print("Error while parsing " + os.path.join(args.project_dir, "pyproject.toml") + f": {ex.args[0]}", file=sys.stderr)
+            else:
+                print("Error while parsing " + os.path.join(args.project_dir, "pyproject.toml"), file=sys.stderr)
+            sys.exit(1)
+
+
 def check_key(project_dir: str, pyproject: PyprojectDict, key: str, error_list: list[str], checks: list[str]) -> None:
     if key not in pyproject:
         if "required" in checks:
@@ -50,6 +63,13 @@ def check_key(project_dir: str, pyproject: PyprojectDict, key: str, error_list:
     if "bool" in checks:
         if not isinstance(pyproject[key], bool):
             error_list.append(f"\"{key}\" must be a bool")
+    if "string-list" in checks:
+        if not isinstance(pyproject[key], list):
+            error_list.append(f"\"{key}\" must be a list of strings")
+        else:
+            for i in pyproject[key]:
+                if not isinstance(i, str):
+                    error_list.append(f"\"{key}\" must be a list of strings")
 
 
 def check_pyproject(project_dir: str, pyproject: PyprojectDict) -> None:
@@ -69,6 +89,7 @@ def check_pyproject(project_dir: str, pyproject: PyprojectDict) -> None:
     check_key(project_dir, pyproject, "output", error_list, ["string"])
     check_key(project_dir, pyproject, "updateinformation", error_list, ["string"])
     check_key(project_dir, pyproject, "compression", error_list, ["string"])
+    check_key(project_dir, pyproject, "additional-packages", error_list, ["string-list"])
 
     if ("gettext-desktop-entry" in pyproject or "gettext-appstream" in pyproject) and not "gettext-directory" in pyproject:
         error_list.append("\"gettext-directory\" must be set when using gettext")
@@ -122,6 +143,84 @@ def get_icon_size(work_dir: str, icon_path: str) -> tuple[int, int]:
     return (int(width), int(height))
 
 
+def handle_icon(project_dir: str, work_dir: str, app_root: str, pyproject: PyprojectDict) -> None:
+    if "icon" not in pyproject:
+        shutil.copyfile(os.path.join(os.path.dirname(__file__), "default.png"), os.path.join(app_root, ".DirIcon"))
+        shutil.copyfile(os.path.join(os.path.dirname(__file__), "default.png"), os.path.join(app_root, "pyproject-appimage-default.png"))
+        return
+
+    icon_path = os.path.join(project_dir, pyproject["icon"])
+
+    if icon_path.endswith(".png"):
+        shutil.copyfile(icon_path, os.path.join(app_root, ".DirIcon"))
+    else:
+        # If a Icon is not PNG, convert it
+        if icon_path.endswith(".svg"):
+            # https://stackoverflow.com/a/55370062
+            subprocess.run([get_image_magick_command(work_dir), "-background", "none", icon_path, "PNG:" + os.path.join(app_root, ".DirIcon")], check=True)
+        else:
+            subprocess.run([get_image_magick_command(work_dir), icon_path, "PNG:" + os.path.join(app_root, ".DirIcon")], check=True)
+
+    if "rename-icon" in pyproject:
+        icon_name = pyproject["rename-icon"]
+    else:
+        icon_name = os.path.basename(pyproject["icon"])
+
+    shutil.copyfile(icon_path, os.path.join(app_root, icon_name))
+
+    if icon_name.endswith(".svg"):
+        icon_dir = os.path.join(app_root, "usr", "share", "icons", "hicolor", "scalable", "apps")
+    else:
+        icon_size = get_icon_size(work_dir, os.path.join(app_root, icon_name))
+        icon_dir = os.path.join(app_root, "usr", "share", "icons", "hicolor", f"{icon_size[0]}x{icon_size[1]}", "apps")
+
+    if not os.path.isdir(icon_dir):
+        os.makedirs(icon_dir)
+
+    shutil.copyfile(os.path.join(app_root, icon_name), os.path.join(icon_dir, icon_name))
+
+
+def create_desktop_entry(project_dir: str, app_root: str, pyproject: PyprojectDict) -> None:
+    full_pyproject = read_pyproject_file(os.path.join(project_dir, "pyproject.toml"))
+
+    entry = desktop_entry_lib.DesktopEntry()
+
+    if "project" in full_pyproject:
+        entry.Name.default_text = full_pyproject["project"].get("name", "App")
+        if "description" in full_pyproject["project"]:
+            entry.Comment.default_text = full_pyproject["project"]["description"]
+    else:
+        entry.Name.default_text = "App"
+
+    entry.Icon = "pyproject-appimage-default"
+    entry.Exec = pyproject["script"]
+
+    entry.Categories.append("Utility")
+
+    entry.write_file(os.path.join(app_root, "pyproject-appimage-default.desktop"))
+
+
+def handle_desktop_entry(project_dir: str, app_root: str, pyproject: PyprojectDict) -> None:
+    if "desktop-entry" not in pyproject:
+        create_desktop_entry(project_dir, app_root, pyproject)
+        return
+
+    desktop_source_path = os.path.join(project_dir, pyproject["desktop-entry"])
+    desktop_dest_path = os.path.join(app_root, pyproject.get("rename-desktop-entry", os.path.basename(pyproject["desktop-entry"])))
+
+    if pyproject.get("gettext-desktop-entry", False):
+        subprocess.run(["msgfmt", "--desktop", "--template", desktop_source_path, "-d", os.path.join(project_dir, pyproject["gettext-directory"]), "-o", desktop_dest_path], check=True)
+    else:
+        shutil.copyfile(desktop_source_path, desktop_dest_path)
+
+    desktop_share_dir = os.path.join(app_root, "usr", "share", "applications")
+
+    if not os.path.isdir(desktop_share_dir):
+        os.makedirs(desktop_share_dir)
+
+    shutil.copyfile(desktop_dest_path, os.path.join(desktop_share_dir, os.path.basename(desktop_dest_path)))
+
+
 def build_appimage(project_dir: str, work_dir: str, pyproject: PyprojectDict, args: argparse.Namespace) -> None:
     if args.python_version is not None:
         python_version = args.python_version
@@ -164,52 +263,9 @@ def build_appimage(project_dir: str, work_dir: str, pyproject: PyprojectDict, ar
 
     os.symlink(os.path.join("usr", "bin", pyproject["script"]), os.path.join(app_root, "AppRun"))
 
-    if "icon" in pyproject:
-        if pyproject["icon"].endswith(".png"):
-            shutil.copyfile(os.path.join(project_dir, pyproject["icon"]), os.path.join(app_root, os.path.basename(pyproject["icon"])))
-        else:
-            # If a Icon is not PNG, convert it
-            subprocess.run([get_image_magick_command(work_dir), os.path.join(project_dir, pyproject["icon"]), "PNG:" + os.path.join(app_root, os.path.basename(pyproject["icon"]))], check=True)
+    handle_icon(project_dir, work_dir, app_root, pyproject)
 
-        if "rename-icon" in pyproject:
-            os.rename(os.path.join(app_root, os.path.basename(pyproject["icon"])), os.path.join(app_root, pyproject["rename-icon"]))
-            icon_name = pyproject["rename-icon"]
-        else:
-            icon_name = os.path.basename(pyproject["icon"])
-
-        shutil.copyfile(os.path.join(app_root, icon_name), os.path.join(app_root, ".DirIcon"))
-
-        if icon_name.endswith(".svg"):
-            icon_dir = os.path.join(app_root, "usr", "share", "icons", "hicolor", "scalable", "apps")
-        else:
-            icon_size = get_icon_size(work_dir, os.path.join(app_root, icon_name))
-            icon_dir = os.path.join(app_root, "usr", "share", "icons", "hicolor", f"{icon_size[0]}x{icon_size[1]}", "apps")
-
-        if not os.path.isdir(icon_dir):
-            os.makedirs(icon_dir)
-
-        shutil.copyfile(os.path.join(app_root, icon_name), os.path.join(icon_dir, icon_name))
-    else:
-        shutil.copyfile(os.path.join(os.path.dirname(__file__), "default.png"), os.path.join(app_root, ".DirIcon"))
-
-    if "desktop-entry" in pyproject:
-        desktop_source_path = os.path.join(project_dir, pyproject["desktop-entry"])
-        desktop_dest_path = os.path.join(app_root, pyproject.get("rename-desktop-entry", os.path.basename(pyproject["desktop-entry"])))
-
-        if pyproject.get("gettext-desktop-entry", False):
-            subprocess.run(["msgfmt", "--desktop", "--template", desktop_source_path, "-d", os.path.join(project_dir, pyproject["gettext-directory"]), "-o", desktop_dest_path], check=True)
-        else:
-            shutil.copyfile(desktop_source_path, desktop_dest_path)
-
-        desktop_share_dir = os.path.join(app_root, "usr", "share", "applications")
-
-        if not os.path.isdir(desktop_share_dir):
-            os.makedirs(desktop_share_dir)
-
-        shutil.copyfile(desktop_dest_path, os.path.join(desktop_share_dir, os.path.basename(desktop_dest_path)))
-    else:
-        shutil.copyfile(os.path.join(os.path.dirname(__file__), "default.desktop"), os.path.join(app_root, "App.desktop"))
-        os.symlink(".DirIcon", os.path.join(app_root, "Icon.png"))
+    handle_desktop_entry(project_dir, app_root, pyproject)
 
     if "appstream" in pyproject:
         appstream_path = os.path.join(app_root, "usr", "share", "metainfo")
@@ -229,6 +285,9 @@ def build_appimage(project_dir: str, work_dir: str, pyproject: PyprojectDict, ar
         else:
             shutil.copyfile(appstream_source_path, appstream_dest_path)
 
+    if "additional-packages" in pyproject:
+        subprocess.run([os.path.join(app_root, "usr", "bin", "pip"), "install"] +  pyproject["additional-packages"], check=True)
+
     if args.output is not None:
         output = args.output
     elif "output" in pyproject:
@@ -249,6 +308,7 @@ def build_appimage(project_dir: str, work_dir: str, pyproject: PyprojectDict, ar
         imagetool_cmd.append("--comp")
         imagetool_cmd.append(pyproject["compression"])
 
+    imagetool_cmd.append("--no-appstream")
     imagetool_cmd.append(app_root)
     imagetool_cmd.append(output)
 
@@ -284,7 +344,7 @@ def get_toml_section(data: dict[str, Any], name: str) -> Optional[dict[str, Any]
     return current_data
 
 
-def main():
+def main() -> None:
     parser = argparse.ArgumentParser()
     parser.add_argument("--output", help="Sets the putput filename")
     parser.add_argument("--project-dir", help="Sets the project dir", default=os.getcwd())
@@ -310,15 +370,7 @@ def main():
         print(os.path.join(args.project_dir, "pyproject.toml") + " does not exists", file=sys.stderr)
         sys.exit(1)
 
-    with open(os.path.join(args.project_dir, "pyproject.toml"), "rb") as f:
-        try:
-            data = toml_load(f)
-        except Exception as ex:
-            if len(ex.args) == 1:
-                print("Error while parsing " + os.path.join(args.project_dir, "pyproject.toml") + f": {ex.args[0]}", file=sys.stderr)
-            else:
-                print("Error while parsing " + os.path.join(args.project_dir, "pyproject.toml"), file=sys.stderr)
-            sys.exit(1)
+    data = read_pyproject_file(os.path.join(args.project_dir, "pyproject.toml"))
 
     pyproject = get_toml_section(data, PYPROJECT_SECTION)
 
@@ -340,7 +392,7 @@ def main():
             pass
 
         try:
-            build_appimage(args.project_dir, args.work_dir, pyproject, args)
+            build_appimage(args.project_dir, os.path.abspath(args.work_dir), pyproject, args)
         except subprocess.CalledProcessError as ex:
             print("Error while running " + str(ex.cmd), file=sys.stderr)
             sys.exit(1)

pyproject-appimage-4.0/pyproject_appimage/version.txt

@@ -0,0 +1 @@
+4.0

{pyproject-appimage-3.0 → pyproject-appimage-4.0/pyproject_appimage.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyproject-appimage
-Version: 3.0
+Version: 4.0
 Summary: Generate AppImages from your Python projects
 Author-email: JakobDev <jakobdev@gmx.de>
 License: BSD-2-Clause
@@ -24,6 +24,9 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: desktop-entry-lib
+Requires-Dist: tomli; python_version < "3.11"
 
 # pyproject-appimage
 
@@ -56,11 +59,15 @@ The following options can be used in your pyproject.toml:
 | rename-icon | string | Give your Icon another name inside the AppImage |
 | desktop-entry | string | The path to your .desktop file |
 | rename-desktop-entry | string | Give your .desktop file another name inside the AppImage |
+| gettext-desktop-entry | bool | If your .desktop file should be translated using gettest |
 | appstream | string | The path to your AppStream file |
 | rename-appstream | string | Give your AppStream file another name inside the AppImage |
+| gettext-appstream | bool | If your AppStream file should be translated using gettest |
+| gettext-directory | string | The path to your gettext directory |
 | python-version | string | The Python version that is used. Default is your current version. Can be overwritten with the cli. |
 | updateinformation | string | The [update information](https://github.com/AppImage/AppImageSpec/blob/master/draft.md#update-information)
 | compression | string | The Squashfs compression
+| additional-packages | list of strins | A list of packages that should also be installed
 
 Note: All paths are relativ to your project directory
 
@@ -86,6 +93,9 @@ options:
   -v, --version         Prints the version and exit
 ```
 
+## Projects using pyproject-appimage
+* [jdNBTExplorer](https://codeberg.org/JakobDev/jdNBTExplorer)
+
 [pyproject-appimage is of course also available as AppImage](https://codeberg.org/JakobDev/pyproject-appimage/releases/latest)
 
 pyproject-appimage is based [on the work of niess](https://github.com/niess/python-appimage)

{pyproject-appimage-3.0 → pyproject-appimage-4.0}/pyproject_appimage.egg-info/SOURCES.txt

@@ -3,7 +3,6 @@ README.md
 pyproject.toml
 pyproject_appimage/__init__.py
 pyproject_appimage/__main__.py
-pyproject_appimage/default.desktop
 pyproject_appimage/default.png
 pyproject_appimage/version.txt
 pyproject_appimage.egg-info/PKG-INFO

{pyproject-appimage-3.0 → pyproject-appimage-4.0}/pyproject_appimage.egg-info/requires.txt

@@ -1,4 +1,5 @@
 requests
+desktop-entry-lib
 
 [:python_version < "3.11"]
 tomli

pyproject-appimage-3.0/pyproject_appimage/default.desktop

@@ -1,6 +0,0 @@
-[Desktop Entry]
-Name=App
-Type=Application
-Exec=AppRun
-Icon=Icon
-Categories=Development;

pyproject-appimage-3.0/pyproject_appimage/version.txt

@@ -1 +0,0 @@
-3.0