Added packaging support, fixed PyInstaller-compiled GUI opening console window together with GUI.

Author: Shararamosh

.github/workflows/build_executable.yml

@@ -22,17 +22,16 @@ jobs:
       - name: Run PyInstaller for Deserializer, Downloader and Batch Deserializer
         run: |
           set PYTHONOPTIMIZE=2
-          pyinstaller --onefile --name="flatc_deserializer" --console --icon=images\flatbuffers-logo-clean.png --add-data="images:images" --add-data="localization:localization" flatc_deserializer.py
-          pyinstaller --onefile --name="flatc_downloader" --console --icon=images\flatbuffers-downloader-logo-clean.png --add-data="images:images" --add-data="localization:localization" flatc_downloader.py
-          pyinstaller --onefile --name="flatc_deserializer_batch" --console --icon=images\flatbuffers-batch-logo-clean.png --add-data="images:images" --add-data="localization:localization" flatc_deserializer_batch.py
+          pyinstaller --onefile --name="flatc_deserializer" --console --icon=src\flatc_deserializer\images\flatbuffers-logo-clean.png --add-data="src\flatc_deserializer\images:images" --add-data="src\flatc_deserializer\localization:localization" deserializer.py
+          pyinstaller --onefile --name="flatc_downloader" --console --icon=src\flatc_deserializer\images\flatbuffers-downloader-logo-clean.png --add-data="src\flatc_deserializer\images:images" --add-data="src\flatc_deserializer\localization:localization" downloader.py
+          pyinstaller --onefile --name="flatc_deserializer_batch" --console --icon=src\flatc_deserializer\images\flatbuffers-batch-logo-clean.png --add-data="src\flatc_deserializer\images:images" --add-data="src\flatc_deserializer\localization:localization" deserializer_batch.py
       - name: Install additional GUI requirements
         run: |
-          pip install -r requirements_frontend.txt
           pip install pywinstyles
       - name: Run PyInstaller for GUI
         run: |
           set PYTHONOPTIMIZE=2
-          pyinstaller --onefile --noconsole --name="flatc_deserializer_frontend" --console --hiddenimport pywinstyles --icon=images\flatbuffers-logo-clean.png --add-data="images:images" --add-data="localization:localization" flatc_deserializer_frontend.py
+          pyinstaller --onefile --noconsole --name="flatc_deserializer_frontend" --hiddenimport pywinstyles --icon=src\flatc_deserializer\images\flatbuffers-logo-clean.png --add-data="src\flatc_deserializer\images:images" --add-data="src\flatc_deserializer\localization:localization" deserializer_frontend.py
       - name: Move Executables from dist to root directory and delete dist directory
         run: |
           move dist\flatc_deserializer.exe .

.github/workflows/build_executable_nuitka.yml

@@ -23,52 +23,52 @@ jobs:
         uses: Nuitka/Nuitka-Action@main
         with:
           nuitka-version: main
-          script-name: flatc_deserializer.py
+          script-name: src/flatc_deserializer/deserializer.py
+          output-file: flatc_deserializer
           mode: app
           enable-plugins: tk-inter
           include-data-dir: |
-            localization=localization
-            images=images
-          windows-icon-from-ico: images/flatbuffers-logo-clean.png
+            src/flatc_deserializer/localization=localization
+            src/flatc_deserializer/images=images
+          windows-icon-from-ico: src/flatc_deserializer/images/flatbuffers-logo-clean.png
       - name: Run Nuitka for Downloader
         uses: Nuitka/Nuitka-Action@main
         with:
           nuitka-version: main
-          script-name: flatc_downloader.py
+          script-name: src/flatc_deserializer/downloader.py
+          output-file: flatc_downloader
           mode: app
           enable-plugins: tk-inter
           include-data-dir: |
-            localization=localization
-            images=images
-          windows-icon-from-ico: images/flatbuffers-downloader-logo-clean.png
+            src/flatc_deserializer/localization=localization
+            src/flatc_deserializer/images=images
+          windows-icon-from-ico: src/flatc_deserializer/images/flatbuffers-downloader-logo-clean.png
       - name: Run Nuitka for Batch Deserializer
         uses: Nuitka/Nuitka-Action@main
         with:
           nuitka-version: main
-          script-name: flatc_deserializer_batch.py
+          script-name: src/flatc_deserializer/deserializer_batch.py
+          output-file: flatc_deserializer_batch
           mode: app
           enable-plugins: tk-inter
           include-data-dir: |
-            localization=localization
-            images=images
-          windows-icon-from-ico: images/flatbuffers-batch-logo-clean.png
-      - name: Install additional GUI requirements
-        run: |
-          pip install -r requirements_frontend.txt
-          pip install pywinstyles
+            src/flatc_deserializer/localization=localization
+            src/flatc_deserializer/images=images
+          windows-icon-from-ico: src/flatc_deserializer/images/flatbuffers-batch-logo-clean.png
       - name: Run Nuitka for GUI
         uses: Nuitka/Nuitka-Action@main
         with:
           nuitka-version: main
-          script-name: flatc_deserializer_frontend.py
+          script-name: src/flatc_deserializer/deserializer_frontend.py
+          output-file: flatc_deserializer_frontend
           mode: app
           windows-console-mode: disable
           enable-plugins: tk-inter
           include-package: pywinstyles
           include-data-dir: |
-            localization=localization
-            images=images
-          windows-icon-from-ico: images/flatbuffers-logo-clean.png
+            src/flatc_deserializer/localization=localization
+            src/flatc_deserializer/images=images
+          windows-icon-from-ico: src/flatc_deserializer/images/flatbuffers-logo-clean.png
       - name: Move Executables from build to root directory
         run: |
           move build\flatc_deserializer.exe .

MANIFEST.in

@@ -0,0 +1,2 @@
+graft src/flatc_deserializer/images
+graft src/flatc_deserializer/localization

README.MD

@@ -11,7 +11,8 @@ Set of console tools and single combined GUI for the following:
 ### GUI only:
 - [customtkinter](https://pypi.org/project/customtkinter/)
 - [CTkMenuBar](https://pypi.org/project/CTkMenuBar/)
-- [CTkMessagebox](https://pypi.org/project/CTkMessagebox/)
+#### Optional (Windows only):
+- [pywinstyles](https://pypi.org/project/pywinstyles/) - adds drag-and-drop support.
 ## Latest Windows releases:
 - [PyInstaller](https://github.com/Shararamosh/flatc_deserializer/releases/tag/latest)
 - [Nuitka](https://github.com/Shararamosh/flatc_deserializer/releases/tag/latest-nuitka)

pyproject.toml

@@ -1,13 +1,20 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
 [project]
 name="flatc_deserializer"
 dynamic = ["version"]
+requires-python = ">= 3.11"
 dependencies = [
     "pillow",
     "tqdm",
-    "i18nice[YAML]"
+    "i18nice[YAML]",
+    "customtkinter",
+    "CTkMenuBar",
+    "pywinstyles; os_name == 'nt'"
 ]
 authors = [{name = "Shararamosh"}]
-description = "Program for deserialization of Flatbuffers binary files based on single or multiple schemas."
+description = "Console and GUI apps for deserialization of Flatbuffers binary files based on single or multiple schemas."
 keywords = [
     "json",
     "flatbuffers",
@@ -22,10 +29,20 @@ classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Environment :: Console",
     "Intended Audience :: Developers",
+    "Intended Audience :: End Users/Desktop",
     "Natural Language :: English",
     "Natural Language :: Russian",
     "Operating System :: OS Independent",
-    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.11",
     "Topic :: File Formats :: JSON",
     "Topic :: Utilities"
 ]
+readme = "README.MD"
+[project.urls]
+Repository = "https://github.com/Shararamosh/flatc_deserializer.git"
+[project.scripts]
+flatc_downloader = "flatc_deserializer.downloader:main"
+flatc_deserializer = "flatc_deserializer.deserializer:main"
+flatc_deserializer_batch = "flatc_deserializer.deserializer_batch:main"
+[project.gui-scripts]
+flatc_deserializer_frontend = "flatc_deserializer.deserializer_frontend:main"

requirements.txt

@@ -1,5 +1,6 @@
 pillow
 tqdm
 i18nice[YAML]
-future
-argparse
+customtkinter
+CTkMenuBar
+pywinstyles; os_name == 'nt'

requirements_frontend.txt

@@ -7,10 +7,15 @@
 import argparse
 from i18n import t
 
-from main import init_app, get_flatc_path, execute_deserialize
+from flatc_deserializer.general_funcs import init_app, get_flatc_path, execute_deserialize
 
-if __name__ == "__main__":
-    init_app("images/flatbuffers-logo-clean.png")
+
+def main() -> int | str:
+    """
+    Запуск скрипта.
+    :return: Код ошибки или строка об ошибке.
+    """
+    init_app(os.path.join("images", "flatbuffers-logo-clean.png"))
     parser = argparse.ArgumentParser(prog=t("main.flatc_deserializer_name"),
                                      description=t("main.flatc_deserializer_desc"))
     parser.add_argument("-s", "--schema_path", type=str, default="", help=t("main.schema_file_arg"))
@@ -20,6 +25,10 @@
                         help=t("main.output_directory_arg"))
     parser.add_argument("-f", "--flatc_path", type=str, default="", help=t("main.flatc_path_arg"))
     args = parser.parse_args()
-    sys.exit(execute_deserialize(
+    return execute_deserialize(
         get_flatc_path(os.getcwd(), True, False) if args.flatc_path == "" else args.flatc_path,
-        args.schema_path, args.binary_paths, args.output_path))
+        args.schema_path, args.binary_paths, args.output_path)
+
+
+if __name__ == "__main__":
+    sys.exit(main())

flatc_deserializer.py renamed to src/flatc_deserializer/deserializer.py

@@ -8,10 +8,15 @@
 import argparse
 from i18n import t
 
-from main import init_app, get_flatc_path, execute_deserialize_batch
+from flatc_deserializer.general_funcs import init_app, get_flatc_path, execute_deserialize_batch
 
-if __name__ == "__main__":
-    init_app("images/flatbuffers-batch-logo-clean.png")
+
+def main() -> int | str:
+    """
+    Запуск скрипта.
+    :return: Код ошибки или строка об ошибке.
+    """
+    init_app(os.path.join("images", "flatbuffers-batch-logo-clean.png"))
     parser = argparse.ArgumentParser(prog=t("main.flatc_deserializer_batch_name"),
                                      description=t("main.flatc_deserializer_batch_desc"))
     parser.add_argument("-s", "--schemas_path", type=str, default="",
@@ -22,6 +27,10 @@
                         help=t("main.output_directory_arg"))
     parser.add_argument("-f", "--flatc_path", type=str, default="", help=t("main.flatc_path_arg"))
     args = parser.parse_args()
-    sys.exit(execute_deserialize_batch(
+    return execute_deserialize_batch(
         get_flatc_path(os.getcwd(), True, False) if args.flatc_path == "" else args.flatc_path,
-        args.schemas_path, args.binaries_path, args.output_path))
+        args.schemas_path, args.binaries_path, args.output_path)
+
+
+if __name__ == "__main__":
+    sys.exit(main())

flatc_deserializer_batch.py renamed to src/flatc_deserializer/deserializer_batch.py

@@ -4,10 +4,9 @@
 # pylint: disable=import-error
 import os
 import sys
-import tkinter.filedialog
 from collections.abc import Callable
 from importlib import import_module
-from tkinter import ttk, messagebox
+from tkinter import ttk, messagebox, filedialog
 
 from PIL.ImageTk import PhotoImage
 from PIL import Image
@@ -16,9 +15,9 @@
 from customtkinter import CTk, CTkFrame, CTkButton, CTkImage, NSEW, EW, RIGHT
 from CTkMenuBar import CTkMenuBar
 
-from main import init_localization, get_resource_path, execute_download, get_flatc_path, \
-    get_binary_tuples
-from flatc_funcs import deserialize
+from flatc_deserializer.general_funcs import init_localization, get_resource_path, \
+    execute_download, get_flatc_path, get_binary_tuples
+from flatc_deserializer.flatc_funcs import deserialize
 
 
 def attempt_apply_dnd(widget_id: int, dnd_event: Callable):
@@ -53,7 +52,7 @@ def __init__(self):
         self.geometry(f"{width}x{height}")
         self.title(t("main.flatc_deserializer_name"))
         self.wm_iconbitmap()
-        img = Image.open(get_resource_path("images/flatbuffers-logo-clean.png"))
+        img = Image.open(get_resource_path(os.path.join("images", "flatbuffers-logo-clean.png")))
         self.iconphoto(True, PhotoImage(img))
         self._create_top_menu()
         main_frame = self._create_main_frame()
@@ -72,7 +71,8 @@ def _create_top_menu(self) -> CTkMenuBar:
         :return: Created menu.
         """
         top_menu = CTkMenuBar(self, bg_color=None)
-        img = Image.open(get_resource_path("images/flatbuffers-downloader-logo-clean.png"))
+        img = Image.open(
+            get_resource_path(os.path.join("images", "flatbuffers-downloader-logo-clean.png")))
         flatc_button = top_menu.add_cascade(image=CTkImage(img))
         flatc_button.configure(text=t("frontend.download_flatc"))
         flatc_button.configure(command=self.flatc_button_pressed)
@@ -241,7 +241,8 @@ def _create_bottom_menu(self) -> CTkMenuBar:
         :return: Created menu.
         """
         bottom_menu = CTkMenuBar(self, bg_color=None)
-        img = Image.open(get_resource_path("images/flatbuffers-batch-logo-clean.png"))
+        img = Image.open(
+            get_resource_path(os.path.join("images", "flatbuffers-batch-logo-clean.png")))
         deserialize_button = bottom_menu.add_cascade(image=CTkImage(img))
         deserialize_button.configure(text=t("frontend.deserialize"))
         deserialize_button.configure(command=self.deserialize_button_pressed)
@@ -259,7 +260,7 @@ def on_binary_add_click(self):
         """
         Triggered when "Add..." button is clicked.
         """
-        binary_paths = tkinter.filedialog.askopenfilenames(title=t("main.tkinter_binaries_select"))
+        binary_paths = filedialog.askopenfilenames(title=t("main.tkinter_binaries_select"))
         if binary_paths is not None:
             self.on_binary_dropped(binary_paths)
 
@@ -288,7 +289,7 @@ def on_schema_add_click(self):
         """
         Triggered when "Add..." button is clicked.
         """
-        schema_paths = tkinter.filedialog.askopenfilenames(
+        schema_paths = filedialog.askopenfilenames(
             title=t("main.tkinter_fbs_multiple_select"),
             filetypes=[(t("main.fbs_filetype"), "*.fbs")])
         if schema_paths is not None:
@@ -319,7 +320,7 @@ def on_change_dest_click(self):
         for selected_item in selected_items:
             file_path = self.dest_binaries_table.set(selected_item, 0)
             file_dir, file_name = os.path.split(file_path)
-            new_file_path = tkinter.filedialog.asksaveasfilename(
+            new_file_path = filedialog.asksaveasfilename(
                 title=t("main.save_selected_file"),
                 defaultextension=".json",
                 initialdir=file_dir, initialfile=file_name,
@@ -456,8 +457,17 @@ def _deserialize_and_update_table(self, flatc_path: str, schema_path: str, binar
             self.dest_binaries_table.update()
 
 
-if __name__ == "__main__":
+def main() -> str | int:
+    """
+    Launching script.
+    :return: Error code or string with error.
+    """
     init_localization()
     ctk.set_appearance_mode("System")
     ctk.set_default_color_theme("blue")
     Deserializer().mainloop()
+    return os.EX_OK
+
+
+if __name__ == "__main__":
+    sys.exit(main())

flatc_deserializer_frontend.py renamed to src/flatc_deserializer/deserializer_frontend.py

@@ -7,13 +7,22 @@
 import argparse
 from i18n import t
 
-from main import init_app, execute_download
+from flatc_deserializer.general_funcs import init_app, execute_download
 
-if __name__ == "__main__":
-    init_app("images/flatbuffers-downloader-logo-clean.png")
+
+def main() -> int | str:
+    """
+    Запуск скрипта.
+    :return: Код ошибки или строка с ошибкой.
+    """
+    init_app(os.path.join("images", "flatbuffers-downloader-logo-clean.png"))
     parser = argparse.ArgumentParser(prog=t("main.flatc_downloader_name"),
                                      description=t("main.flatc_downloader_desc"))
     parser.add_argument("downloads_directory", nargs="?", type=str, default=os.getcwd(),
                         help=t("main.download_directory_arg"))
     args = parser.parse_args()
-    sys.exit(execute_download(args.downloads_directory))
+    return execute_download(args.downloads_directory)
+
+
+if __name__ == "__main__":
+    sys.exit(main())

flatc_download_funcs.py renamed to src/flatc_deserializer/download_funcs.py

@@ -18,8 +18,8 @@
 from tqdm import tqdm
 from tqdm.contrib.logging import logging_redirect_tqdm
 
-from flatc_download_funcs import download_flatc
-from flatc_funcs import deserialize
+from flatc_deserializer.download_funcs import download_flatc
+from flatc_deserializer.flatc_funcs import deserialize
 
 
 def get_resource_path(file_path: str) -> str:
@@ -33,7 +33,7 @@ def get_resource_path(file_path: str) -> str:
     elif hasattr(sys, "_MEIPASS"):
         base_path = getattr(sys, "_MEIPASS")
     else:
-        base_path = os.path.abspath(".")
+        base_path = os.path.dirname(__file__)
     return os.path.join(base_path, file_path)