p3lib 1.1.101__py3-none-any.whl → 1.1.102__py3-none-any.whl

p3lib/gnome_desktop_app.py

@@ -0,0 +1,132 @@
+#!/bin/env python3
+
+import os
+import sys
+import platform
+
+class GnomeDesktopApp(object):
+    """@brief Responsible for adding and removing gnome desktop files for launching applications on a Linux system."""
+
+    @staticmethod
+    def IsLinux():
+        """@return True if running on a Linux platform."""
+        linux = False
+        if platform.system() == "Linux":
+            linux = True
+        return linux
+
+    def __init__(self, icon_file, app_name=None, comment='', categories='Utility;Application;'):
+        """@brief Constructor.
+           @param icon_file  The name of the icon file. This can be an absolute file name the filename on it's own.
+                             If just a filename is passed then the icon file must sit in a folder named 'assets'.
+                             This assets folder must be in the same folder as the startup file or it's parent.
+           @param app_name   The name of the application.
+                             If not defined then the name of the program executed at startup is used.
+                             This name has _ and - character replace with space characters and each
+                             word starts with a capital letter.
+           @param comment    This comment should detail what the program does and is stored
+                             in the gnome desktop file that is created.
+           @param categories The debian app categories. default='Utility;Application;'.
+        """
+        if not GnomeDesktopApp.IsLinux():
+            raise Exception("The GnomeDesktopApp() class cannot be instantiated on a non Linux platform")
+        self._startup_file = self._get_startup_file()
+        self._gnome_desktop_file = None
+        self._app_name = self._get_app_name()
+        self._check_icon(icon_file)
+        self._comment = comment
+        self._categories = categories
+        self._gnome_desktop_file = self._get_gnome_desktop_file()
+
+    def _get_startup_file(self):
+        """@return Get the abs name of the program first started."""
+        return os.path.abspath(sys.argv[0])
+
+    def _get_app_name(self, app_name=None):
+        """@brief Get the name of the app.
+           @param app_name The name of the app or None. If None then the name of the app is the
+                  basename of the startup file minus it's extension.
+           @return The name of the app."""
+        if not app_name:
+            # Get just the name of the file
+            app_name = os.path.basename(self._startup_file)
+            # Remove file extension
+            app_name = os.path.splitext(app_name)[0]
+            app_name = app_name.replace('_', ' ')
+            app_name = app_name.replace('-', ' ')
+            app_name = app_name.title()
+        return app_name
+
+    def _check_icon(self, icon_file):
+        """@brief Check that the icon file exists as this is required for the gnome desktop entry.
+           @param icon_file The name of the icon file.
+           return None"""
+        self._abs_icon_file = os.path.abspath(icon_file)
+        if not os.path.isfile(self._abs_icon_file):
+            startup_path = os.path.dirname(self._startup_file)
+            path1 = os.path.join(startup_path, 'assets')
+            self._abs_icon_file = os.path.join(path1, icon_file)
+            if not os.path.isfile(self._abs_icon_file):
+                startup_parent_path = os.path.join(startup_path, '..')
+                path2 = os.path.join(startup_parent_path, 'assets')
+                self._abs_icon_file = os.path.join(path2, icon_file)
+                if not os.path.isfile(self._abs_icon_file):
+                    raise Exception(f"{self._app_name} icon file ({icon_file}) not found.")
+
+    def _get_gnome_desktop_file(self):
+        """@brief Determine and return the name of the gnome desktop file.
+           @return The gnome desktop file."""
+        # Get just the name of the file
+        desktop_file_name = os.path.basename(self._startup_file)
+        # Remove file extension
+        desktop_file_name = os.path.splitext(desktop_file_name)[0]
+        if not desktop_file_name.endswith('.desktop'):
+            desktop_file_name = desktop_file_name + '.desktop'
+        home_folder = os.path.expanduser("~")
+        gnome_desktop_apps_folder = os.path.join(home_folder, '.local/share/applications')
+        gnome_desktop_file = os.path.join(gnome_desktop_apps_folder, desktop_file_name)
+        return gnome_desktop_file
+
+    def _create_gnome_desktop_file(self):
+        """@brief Create the gnome desktop file for this app."""
+        if os.path.isfile(self._gnome_desktop_file):
+            raise Exception(f"{self._gnome_desktop_file} file already exists.")
+        lines = []
+        lines.append('[Desktop Entry]')
+        lines.append('Version=1.0')
+        lines.append('Type=Application')
+        lines.append('Encoding=UTF-8')
+        lines.append(f'Name={self._app_name}')
+        lines.append(f'Comment={self._comment}')
+        lines.append(f'Icon={self._abs_icon_file}')
+        lines.append(f'Exec=python3 {self._startup_file}')
+        lines.append('Terminal=false')
+        lines.append(f'Categories={self._categories}')
+
+        with open(self._gnome_desktop_file, "w", encoding="utf-8") as fd:
+            fd.write("\n".join(lines))
+
+    def create(self, overwrite=False):
+        """@brief Create a desktop icon.
+           @param overwrite If True overwrite any existing file. If False raise an error if the file is already present."""
+        # If this file not found error
+        if not os.path.isfile(self._startup_file):
+            raise Exception(f"{self._startup_file} file not found.")
+        if overwrite:
+            self.delete()
+        self._create_gnome_desktop_file()
+
+    def delete(self):
+        """@brief Delete the gnome desktop file if present"""
+        if os.path.isfile(self._gnome_desktop_file):
+            os.remove(self._gnome_desktop_file)
+
+"""
+    Example usage
+    gda = GnomeDesktopApp('savings.png')
+    gda.create(overwrite=True)
+"""
+
+
+
+

{p3lib-1.1.101.dist-info → p3lib-1.1.102.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: p3lib
-Version: 1.1.101
+Version: 1.1.102
 Summary: A group of python modules for networking, plotting data, config storage, automating boot scripts, ssh access and user input output.
 Home-page: https://github.com/pjaos/p3lib
 Author: Paul Austen

{p3lib-1.1.101.dist-info → p3lib-1.1.102.dist-info}/RECORD

@@ -6,6 +6,7 @@ p3lib/boot_manager.py,sha256=l7WlaoIRt4cu2jAdCs3FnDeNO2v2jzqideNZ3qg2r_4,19652
 p3lib/conduit.py,sha256=jPkjdtyCx2I6SFqcEo8y2g7rgnZ-jNY7oCuYIETzT5Q,6046
 p3lib/database_if.py,sha256=XKu1w3zftGbj4Rh54wrWJnoCtqHkhCzJUPN2S70XIKg,11915
 p3lib/file_io.py,sha256=A7_GKYPlmjRjq6U1YuWhmB0OhLhNm6cWQfQX8qfgYTk,5041
+p3lib/gnome_desktop_app.py,sha256=28DKBDyyr7Dj4rSGvtUOBfhepdB7TEmsO0mNyuPY4K4,6002
 p3lib/helper.py,sha256=xTKPgpziwr4zyaoc0sjZRFr0M91fo7Tok_nSAvtiTZE,12020
 p3lib/json_networking.py,sha256=6u4s1SmypjTYPnSxHP712OgQ3ZJaxOqIkgHQ1J7Qews,9738
 p3lib/mqtt_rpc.py,sha256=6LmFA1kR4HSJs9eWbOJORRHNY01L_lHWjvtE2fmY8P8,10511
@@ -16,8 +17,8 @@ p3lib/pconfig.py,sha256=2yZUK5nkqpAm4Y_xcJq5H9Lxmc8dfYei1Pi0Ek2Crh0,35376
 p3lib/ssh.py,sha256=OyoAQ_h1L2RfkjTAChDrvLFfl4Fe_gBNdX5rvK-wKiw,42125
 p3lib/table_plot.py,sha256=RPncwVlGUkkx5Fw0dHQedXo0TSPlTi__VrJBDzaMsuI,32116
 p3lib/uio.py,sha256=Aaxc99XiE3d2f9vLjaN-bZsckoNxay5t0ujdK6PXGrw,23265
-p3lib-1.1.101.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
-p3lib-1.1.101.dist-info/METADATA,sha256=gdbF0zh48zjUc6LXovhTgsfcFldo1mzLJBClcS9iJL4,919
-p3lib-1.1.101.dist-info/WHEEL,sha256=A3WOREP4zgxI0fKrHUG8DC8013e3dK3n7a6HDbcEIwE,91
-p3lib-1.1.101.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
-p3lib-1.1.101.dist-info/RECORD,,
+p3lib-1.1.102.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
+p3lib-1.1.102.dist-info/METADATA,sha256=zZYfEUvcBThnWJPLgVeK3lIulUngLupoWwlQ7bfAdl8,919
+p3lib-1.1.102.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+p3lib-1.1.102.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
+p3lib-1.1.102.dist-info/RECORD,,

{p3lib-1.1.101.dist-info → p3lib-1.1.102.dist-info}/WHEEL

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