Added file dialog for selecting JSON files and setuptools installation support.

Author: Shararamosh

.github/workflows/build_executable.yml

@@ -15,14 +15,15 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: 3.11
-      - name: Install PyInstaller and Pillow
+      - name: Install PyInstaller and requirements
         run: |
           pip install pyinstaller
           pip install pillow
+          pip install rich
       - name: Run PyInstaller for BDSP_ColorVariation_JSONParser
         run: |
           set PYTHONOPTIMIZE=2
-          pyinstaller --onefile --name="BDSP_ColorVariation_JSONParser" --console --icon=images\BDSP_ColorVariation_JSONParser.tga bdsp_colorvariation_jsonparser.py
+          pyinstaller --onefile --name="BDSP_ColorVariation_JSONParser" --console --icon=src\BDSP_ColorVariation_JSONParser\images\json_parser.tga src\BDSP_ColorVariation_JSONParser\json_parser.py
       - name: Move Executable from dist to root directory
         run: |
           move dist\BDSP_ColorVariation_JSONParser.exe .

.github/workflows/build_executable_nuitka.yml

@@ -15,15 +15,20 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: 3.11
+      - name: Install requirements
+        run: |
+          pip install pillow
+          pip install rich
       - name: Install imageio
         run: pip install imageio
       - name: Run Nuitka for BDSP_ColorVariation_JSONParser
         uses: Nuitka/Nuitka-Action@main
         with:
           nuitka-version: main
-          script-name: bdsp_colorvariation_jsonparser.py
+          script-name: src/BDSP_ColorVariation_JSONParser/json_parser.py
           mode: app
-          windows-icon-from-ico: "images/BDSP_ColorVariation_JSONParser.tga"
+          enable-plugins: tk-inter
+          windows-icon-from-ico: "src/BDSP_ColorVariation_JSONParser/images/json_parser.tga"
       - name: Move Executable from build to root directory
         run: |
           move build\BDSP_ColorVariation_JSONParser.exe .

.github/workflows/greetings.yml

@@ -1,4 +1,14 @@
 # Pokémon Brilliant Diamond/Shining Pearl ColorVariation Parser
-This script outputs color information from `ColorVariation.json` files originated from Pokémon BD/SP video games.
+Console tool for parsing color information from `ColorVariation.json` files originated from Pokémon BD/SP video games.
 
-Multiple JSON files are supported if provided as launch arguments.
+Multiple JSON files are supported if provided as launch arguments or selected with file dialog.
+## Installation
+### Option 1: Pre-compiled builds
+#### Latest Windows releases:
+- [PyInstaller](https://github.com/Shararamosh/BDSP_ColorVariation_JSONParser/releases/tag/latest)
+- [Nuitka](https://github.com/Shararamosh/BDSP_ColorVariation_JSONParser/releases/tag/latest-nuitka)
+### Option 2: Installing using pip
+```pip install git+https://github.com/Shararamosh/BDSP_ColorVariation_JSONParser.git```
+#### Requirements:
+- [Pillow](https://pypi.org/project/pillow/)
+- [Rich](https://pypi.org/project/rich)

README.md

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+[project]
+name="BDSP_ColorVariation_JSONParser"
+dynamic = ["version"]
+requires-python = ">= 3.11"
+dependencies = [
+    "pillow",
+    "rich"
+]
+authors = [{name = "Shararamosh"}]
+description = "Console tool for parsing color information from Pokémon BD/SP ColorVariation.json files."
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: End Users/Desktop",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.11",
+    "Topic :: Utilities"
+]
+readme = "README.MD"
+[project.urls]
+Repository = "https://github.com/Shararamosh/BDSP_ColorVariation_JSONParser.git"
+[project.scripts]
+json_parser = "BDSP_ColorVariation_JSONParser.json_parser:main"

pyproject.toml

@@ -1,10 +1,15 @@
 """
-    Script for parsing color information from Pokémon BD/SP ColorVariation.json files.
+    Script containing functions to deal with JSON files from Pokémon BD/SP games.
 """
+# pylint: disable=import-error, wrong-import-position
 import os
 import sys
 import json
-import argparse
+import logging
+
+sys.path.append(os.path.join(os.path.dirname(__file__), "."))
+
+from general import RICH_CONSOLE
 
 
 def print_json_color_data(file_path: str):
@@ -13,33 +18,33 @@ def print_json_color_data(file_path: str):
     :param file_path: Path to JSON file.
     """
     if not os.path.exists(file_path):
-        print("Path does not exist.")
+        logging.warning("Path %s does not exist.", file_path)
         return
     if not os.path.isfile(file_path):
-        print("Path is not a file.")
+        logging.warning("Path %s is not a file.", file_path)
         return
     if not file_path.lower().endswith(".json"):
-        print("Path is not a JSON file.")
+        logging.warning("Path %s is not a JSON file.", file_path)
         return
     with open(file_path, encoding="utf-8") as json_file:
+        RICH_CONSOLE.print(f"{file_path}:")
         json_data = json.load(json_file)
         k = 0
         s = "00"
         while "Property" + s in json_data:
             property_data = json_data["Property" + s][0]
-            print("Property" + s + ":")
+            RICH_CONSOLE.print(f"Property {s}:")
             colors_data = property_data["colors"]
             current_material_index = -1
             for color_data in colors_data:
                 if color_data is not None:
                     c = color_data["channel"]
                     if color_data["materialIndex"] > current_material_index:
                         current_material_index = color_data["materialIndex"]
-                        print("Material Index: " + str(current_material_index) + ".")
+                        RICH_CONSOLE.print(f"Material Index: {current_material_index}.")
                     color_dict = color_data["color"]
                     if color_dict is not None:
-                        color_dict_str = get_color_dict_str(color_dict)
-                        print(f"[{c:d}]: {color_dict_str}.")
+                        RICH_CONSOLE.print(f"[{c:d}]: {get_color_dict_str(color_dict)}.")
             k = k + 1
             if k < 10:
                 s = "0" + str(k)
@@ -62,20 +67,3 @@ def get_color_dict_str(color_dict: dict) -> str:
     hc = hc + format(round(float(color_dict["g"]) * 255.0), "x").upper()
     hc = hc + format(round(float(color_dict["b"]) * 255.0), "x").upper()
     return f"{lc} -> {hc}"
-
-
-if __name__ == "__main__":
-    parser = argparse.ArgumentParser(prog="BD/SP ColorVariation Parser",
-                                     description="Parser for Pokémon BD/SP "
-                                                 "ColorVariation.json files.")
-    parser.add_argument("input_paths", nargs="*", type=str, default="",
-                        help="Input JSON files")
-    args = parser.parse_args()
-    if len(args.input_paths) < 1:
-        input_path = input("JSON file path: ")
-        print_json_color_data(input_path)
-    else:
-        for input_path in args.input_paths:
-            print(f"{input_path}:")
-            print_json_color_data(input_path)
-    sys.exit(os.EX_OK)

bdsp_colorvariation_jsonparser.py …P_ColorVariation_JSONParser/bdsp_json.pybdsp_colorvariation_jsonparser.py renamed to src/BDSP_ColorVariation_JSONParser/bdsp_json.py bdsp_colorvariation_jsonparser.py renamed to src/BDSP_ColorVariation_JSONParser/bdsp_json.py

@@ -0,0 +1,39 @@
+"""
+    Script containing general functions.
+"""
+import os
+import sys
+import logging
+from tkinter import Tk
+from PIL.ImageTk import PhotoImage
+from rich.logging import RichHandler
+from rich.console import Console
+
+RICH_CONSOLE = Console()
+
+
+def get_resource_path(file_path: str) -> str:
+    """
+    Returns path to file or directory inside project, when used PyInstaller or Nuitka are used.
+    :param file_path: Original path to file or directory.
+    :return: Modified path to file or directory.
+    """
+    if "NUITKA_ONEFILE_PARENT" in os.environ:
+        base_path = os.path.dirname(sys.executable)
+    elif hasattr(sys, "_MEIPASS"):
+        base_path = getattr(sys, "_MEIPASS")
+    else:
+        base_path = os.path.dirname(__file__)
+    return os.path.join(base_path, file_path)
+
+
+def init_app(icon_path: str):
+    """
+    Initiating app for launch.
+    :param icon_path: Path to icon file.
+    """
+    logging.basicConfig(format="%(message)s", level=logging.INFO, handlers=[
+        RichHandler(level=logging.INFO, console=RICH_CONSOLE, rich_tracebacks=True)])
+    root = Tk()
+    root.withdraw()
+    root.iconphoto(True, PhotoImage(file=get_resource_path(icon_path)))

src/BDSP_ColorVariation_JSONParser/general.py

@@ -0,0 +1,37 @@
+"""
+    Script for parsing color information from Pokémon BD/SP ColorVariation.json files.
+"""
+# pylint: disable=import-error, wrong-import-position
+import os
+import sys
+import argparse
+from tkinter.filedialog import askopenfilenames
+
+from bdsp_json import print_json_color_data
+
+sys.path.append(os.path.join(os.path.dirname(__file__), "."))
+
+from general import init_app, get_resource_path
+
+
+def main() -> int | str:
+    """
+    Program for parsing color information from Pokémon BD/SP ColorVariation.json files.
+    :return: Status code or string.
+    """
+    init_app(get_resource_path(os.path.join("images", "json_parser.tga")))
+    parser = argparse.ArgumentParser(description="Parser for Pokémon BD/SP "
+                                                 "ColorVariation.json files.")
+    parser.add_argument("input_paths", nargs="*", type=str, default="",
+                        help="Input JSON files")
+    args = parser.parse_args()
+    if len(args.input_paths) < 1:
+        args.input_paths = askopenfilenames(title="Select JSON files",
+                                            filetypes=[("JSON", "*.json")])
+    for input_path in args.input_paths:
+        print_json_color_data(input_path)
+    return os.EX_OK
+
+
+if __name__ == "__main__":
+    sys.exit(main())