pyside-cli 0.1.1__tar.gz

pyside_cli-0.1.1/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.1
+Name: pyside-cli
+Version: 0.1.1
+Summary: Add your description here
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: glom>=24.11.0
+Requires-Dist: nuitka>=2.7.16
+Requires-Dist: pyside6>=6.6.3.1
+Requires-Dist: toml>=0.10.2
+
+# CLI for PySide Template
+
+## Quick Overview
+
+This is a companion CLI for **pyside\_template** (not an official PySide tool).
+
+It helps you quickly create a template project:
+
+```bash
+mkdir app && cd app
+pip install pyside-cli
+pys-cli --create .
+```
+
+You can also build the project or run tests with a single command.  
+Note: running tests requires **pytest**.
+
+```bash
+pys-cli --all --onefile # for build
+pys-cli --test          # for testing
+```
+
+## Links
+
+-   [PyPI - pyside-cli](https://pypi.org/project/pyside-cli/)
+    
+-   [pyside\_template](https://github.com/SHIINASAMA/pyside_template)
+    

pyside_cli-0.1.1/README.md

@@ -0,0 +1,28 @@
+# CLI for PySide Template
+
+## Quick Overview
+
+This is a companion CLI for **pyside\_template** (not an official PySide tool).
+
+It helps you quickly create a template project:
+
+```bash
+mkdir app && cd app
+pip install pyside-cli
+pys-cli --create .
+```
+
+You can also build the project or run tests with a single command.  
+Note: running tests requires **pytest**.
+
+```bash
+pys-cli --all --onefile # for build
+pys-cli --test          # for testing
+```
+
+## Links
+
+-   [PyPI - pyside-cli](https://pypi.org/project/pyside-cli/)
+    
+-   [pyside\_template](https://github.com/SHIINASAMA/pyside_template)
+    

pyside_cli-0.1.1/cli/__main__.py

@@ -0,0 +1,86 @@
+import logging
+import os
+import sys
+
+from cli.args import get_parser
+from cli.builder.build import gen_version_py
+from cli.builder.nuitka import build
+from cli.builder.qt import build_i18n_ts, build_ui, build_i18n, build_assets, gen_init_py
+from cli.cache import load_cache, save_cache
+from cli.create import create
+from cli.git import get_last_tag
+from cli.glob import glob_files
+from cli.pyproject import load_pyproject
+from cli.pytest import run_test
+
+
+def main():
+    source_list = []
+    ui_list = []
+    asset_list = []
+    i18n_list = []
+    lang_list = []
+    cache = {}
+    opt_from_toml = ""
+
+    logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
+
+    args = get_parser().parse_args()
+    if args.backend_args and args.backend_args[0] == "--":
+        args.backend_args = args.backend_args[1:]
+    if args.debug:
+        logging.info('Debug mode enabled.')
+        logging.getLogger().setLevel(logging.DEBUG)
+
+    if args.create:
+        create(args.create)
+        sys.exit(0)
+
+        # check working directory
+    # if 'app' is not in the current working directory, exit
+    if not os.path.exists('app'):
+        logging.error('Please run this script from the project root directory.')
+        sys.exit(1)
+
+    if args.test:
+        code = run_test(args)
+        sys.exit(code)
+    else:
+        (asset_list,
+         i18n_list,
+         source_list,
+         ui_list) = glob_files()
+
+        (opt_from_toml, lang_list) = load_pyproject()
+
+    if not args.no_cache:
+        cache = load_cache()
+    if args.i18n:
+        build_i18n_ts(
+            lang_list=lang_list,
+            cache=cache,
+            files_to_scan=[str(f) for f in ui_list + source_list]
+        )
+    if args.rc or args.all:
+        build_ui(
+            ui_list=ui_list,
+            cache=cache
+        )
+        build_i18n(
+            i18n_list=i18n_list,
+            cache=cache
+        )
+        build_assets(
+            asset_list=asset_list,
+            cache=cache,
+            no_cache=args.no_cache
+        )
+        gen_version_py(get_last_tag())
+        gen_init_py()
+    save_cache(cache)
+    if args.build or args.all:
+        build(args, opt_from_toml)
+
+
+if __name__ == '__main__':
+    main()

pyside_cli-0.1.1/cli/args.py

@@ -0,0 +1,37 @@
+import argparse
+
+
+def get_parser():
+    """parse command line arguments"""
+    # --help: show this help message
+    parser = argparse.ArgumentParser(description='Test and build your app.')
+    # --rc: only convert resources files to python files
+    # --build: only build the app
+    # --all: convert resources files and build the app
+    # --test: run test code
+    # --init: create new project
+    mode_group = parser.add_mutually_exclusive_group(required=True)
+    mode_group.add_argument('--all', action='store_true', help='Convert rc files and build the app')
+    mode_group.add_argument('--build', action='store_true', help='Build the app')
+    mode_group.add_argument('--create', type=str, metavar='NAME', help='Create your project with name')
+    mode_group.add_argument('--i18n', action='store_true',
+                            help='Generate translation files (.ts) for all languages')
+    mode_group.add_argument('--rc', action='store_true', help='Convert rc files to python files')
+    mode_group.add_argument('--test', action='store_true', help='Run test')
+    # --onefile: create a single executable file
+    # --onedir: create a directory with the executable and all dependencies
+    package_format_group = parser.add_mutually_exclusive_group()
+    package_format_group.add_argument('--onefile', action='store_true',
+                                      help='(for build) Create a single executable file')
+    package_format_group.add_argument('--onedir', action='store_true',
+                                      help='(for build) Create a directory with the executable and all dependencies')
+
+    parser.add_argument('--no-cache', action='store_true', help='Ignore existing caches', required=False)
+
+    parser.add_argument('--debug', action='store_true',
+                        help='Enable debug mode, which will output more information during the build process')
+
+    parser.add_argument('backend_args', nargs=argparse.REMAINDER,
+                        help='Additional arguments for the build backend, e.g. -- --xxx=xxx')
+
+    return parser

pyside_cli-0.1.1/cli/builder/build.py

@@ -0,0 +1,24 @@
+import logging
+import os
+
+
+def gen_version_py(version):
+    with open('app/resources/version.py', 'w', encoding='utf-8') as f:
+        f.write(f'__version__ = "{version}"\n')
+
+
+def gen_filelist(root_dir: str, filelist_name: str):
+    paths = []
+    for current_path, dirs, files in os.walk(root_dir, topdown=False):
+        for file in files:
+            relative_path = os.path.relpath(os.path.join(current_path, file), root_dir)
+            logging.debug(relative_path)
+            paths.append(relative_path)
+        relative_path = os.path.relpath(os.path.join(current_path, ""), root_dir)
+        if relative_path != ".":
+            logging.debug(relative_path)
+            paths.append(relative_path)
+
+    with open(filelist_name, "w", encoding="utf-8") as f:
+        f.write("\n".join(paths))
+        f.write("\n")

pyside_cli-0.1.1/cli/builder/nuitka.py

@@ -0,0 +1,44 @@
+import logging
+import os
+import shutil
+import sys
+import time
+from pathlib import Path
+
+from cli.builder.build import gen_filelist
+
+
+def build(args, opt_from_toml):
+    # call nuitka to build the app
+    # include all files in app package and exclude the ui files
+    if sys.platform != 'win32':
+        path = Path('build/App')
+        if path.exists() and path.is_dir():
+            shutil.rmtree(path)
+        elif path.exists() and path.is_file():
+            path.unlink()
+    start = time.perf_counter()
+    logging.info('Building the app...')
+    cmd = ('nuitka '
+           '--output-dir=build '
+           '--output-filename="App" '
+           'app/__main__.py '
+           + '--jobs={} '.format(os.cpu_count())
+           + ('--onefile ' if args.onefile else '--standalone ')
+           + opt_from_toml
+           + (" ".join(args.backend_args)))
+    logging.debug(cmd)
+    rt = os.system(cmd)
+    end = time.perf_counter()
+    if rt == 0:
+        logging.info(f'Build complete in {end - start:.3f}s.')
+        if not args.onefile:
+            if os.path.exists('build/App'):
+                shutil.rmtree('build/App')
+            shutil.move('build/__main__.dist', 'build/App')
+            logging.info("Generate the filelist.")
+            gen_filelist('build/App', 'build/App/filelist.txt')
+            logging.info("Filelist has been generated.")
+    else:
+        logging.error(f'Failed to build app in {end - start:.3f}s.')
+        exit(1)

pyside_cli-0.1.1/cli/builder/qt.py

@@ -0,0 +1,193 @@
+import logging
+import os
+from pathlib import Path
+
+
+def build_ui(ui_list, cache):
+    """Compile *.ui files into Python files using pyside6-uic, preserving directory structure."""
+    ui_dir = Path("app/ui")
+    res_dir = Path("app/resources")
+
+    if not ui_list:
+        logging.info("No ui files found, skipping ui conversion.")
+        return
+
+    res_dir.mkdir(parents=True, exist_ok=True)
+    logging.info("Converting ui files to Python files...")
+    ui_cache = cache.get("ui", {})
+
+    for input_file in ui_list:
+        try:
+            rel_path = input_file.parent.relative_to(ui_dir)
+        except ValueError:
+            # input_file is not under app/ui, skip it
+            continue
+
+        output_dir = res_dir / rel_path
+        output_dir.mkdir(parents=True, exist_ok=True)
+
+        output_file = output_dir / (input_file.stem + "_ui.py")
+
+        # Check cache to avoid unnecessary recompilation
+        mtime = input_file.stat().st_mtime
+        if str(input_file) in ui_cache and ui_cache[str(input_file)] == mtime:
+            logging.info(f"{input_file} is up to date.")
+            continue
+
+        ui_cache[str(input_file)] = mtime
+
+        # Run pyside6-uic
+        cmd = f'pyside6-uic "{input_file}" -o "{output_file}"'
+        if 0 != os.system(cmd):
+            logging.error(f"Failed to convert {input_file}.")
+            exit(1)
+
+        logging.info(f"Converted {input_file} to {output_file}")
+
+    cache["ui"] = ui_cache
+
+
+def build_assets(asset_list, cache, no_cache=False):
+    """Generate assets.qrc from files in app/assets and compile it with pyside6-rcc."""
+    assets_dir = Path('app/assets')
+    res_dir = Path('app/resources')
+    qrc_file = res_dir / 'assets.qrc'
+    py_res_file = res_dir / 'resource.py'
+
+    # Skip if assets directory does not exist
+    if not os.path.exists(assets_dir):
+        logging.info('No assets folder found, skipping assets conversion.')
+        return
+
+    if not os.path.exists(res_dir):
+        os.makedirs(res_dir)
+
+    logging.info('Converting assets to Python resources...')
+
+    assets_cache = cache.get('assets', {})
+    need_rebuild = False
+    for asset in asset_list:
+        mtime = asset.stat().st_mtime
+        asset_key = str(asset)
+        if asset_key in assets_cache and assets_cache[asset_key] == mtime:
+            logging.info(f'{asset} is up to date.')
+            continue
+        assets_cache[asset_key] = mtime
+        logging.info(f'{asset} is outdated.')
+        need_rebuild = True
+
+    # Force rebuild if cache is disabled
+    if no_cache:
+        need_rebuild = True
+
+    if need_rebuild:
+        # Generate assets.qrc dynamically
+        with open(qrc_file, 'w', encoding='utf-8') as f:
+            f.write('<!DOCTYPE RCC>\n')
+            f.write('<RCC version="1.0">\n')
+            f.write('  <qresource>\n')
+            for asset in asset_list:
+                posix_path = asset.as_posix()
+                # remove the leading "app/assets/" from the path
+                alias = posix_path[len('app/assets/'):]
+                # rel_path is the path relative to app/resources
+                rel_path = os.path.relpath(asset, res_dir)
+                f.write(f'    <file alias="{alias}">{rel_path}</file>\n')
+            f.write('  </qresource>\n')
+            f.write('</RCC>\n')
+        logging.info(f'Generated {qrc_file}.')
+
+        # Compile qrc file to Python resource
+        if 0 != os.system(f'pyside6-rcc {qrc_file} -o {py_res_file}'):
+            logging.error('Failed to convert assets.qrc.')
+            exit(1)
+        logging.info(f'Converted {qrc_file} to {py_res_file}.')
+    else:
+        logging.info('Assets are up to date.')
+
+    cache['assets'] = assets_cache
+
+
+def build_i18n_ts(lang_list, files_to_scan, cache):
+    """
+    Generate translation (.ts) files for all languages in lang_list
+    by scanning self.ui_list and self.source_list using pyside6-lupdate.
+    """
+    i18n_dir = Path("app/i18n")
+    i18n_dir.mkdir(parents=True, exist_ok=True)
+
+    logging.info("Generating translation (.ts) files for languages: %s", ', '.join(lang_list))
+
+    i18n_cache = cache.get("i18n", {})
+
+    for lang in lang_list:
+        ts_file = i18n_dir / f"{lang}.ts"
+        logging.info("Generating %s ...", ts_file)
+
+        files_str = " ".join(f'"{f}"' for f in files_to_scan)
+        cmd = f'pyside6-lupdate -silent -locations absolute -extensions ui {files_str} -ts "{ts_file}"'
+
+        if 0 != os.system(cmd):
+            logging.error("Failed to generate translation file: %s", ts_file)
+            exit(1)
+
+        i18n_cache[lang] = ts_file.stat().st_mtime
+        logging.info("Generated translation file: %s", ts_file)
+
+    cache["i18n"] = i18n_cache
+
+
+def build_i18n(i18n_list, cache):
+    """
+    Compile .ts translation files into .qm files under app/assets/i18n/.
+    Only regenerate .qm if the corresponding .ts file has changed.
+    """
+    qm_root = Path("app/assets/i18n")
+    qm_root.mkdir(parents=True, exist_ok=True)
+
+    logging.info("Compiling translation files...")
+
+    # Get cache for i18n
+    i18n_cache = cache.get("i18n", {})
+
+    for ts_file in i18n_list:
+        try:
+            ts_file = Path(ts_file)
+        except Exception:
+            continue
+
+        qm_file = qm_root / (ts_file.stem + ".qm")
+
+        # Check modification time cache
+        ts_mtime = ts_file.stat().st_mtime
+        if str(ts_file) in i18n_cache and i18n_cache[str(ts_file)] == ts_mtime:
+            logging.info("%s is up to date.", ts_file)
+            continue
+
+        logging.info("Compiling %s to %s", ts_file, qm_file)
+
+        # Run pyside6-lrelease to compile ts -> qm
+        cmd = f'pyside6-lrelease "{ts_file}" -qm "{qm_file}"'
+        if 0 != os.system(cmd):
+            logging.error("Failed to compile translation file: %s", ts_file)
+            exit(1)
+
+        logging.info("Compiled %s", qm_file)
+
+        # Update cache
+        i18n_cache[str(ts_file)] = ts_mtime
+
+    cache["i18n"] = i18n_cache
+
+
+def gen_init_py():
+    """Create __init__.py in every subdirectory if not exists"""
+    root = Path("app/resources")
+    init_file = root / "__init__.py"
+    if not init_file.exists():
+        init_file.touch()
+    for path in root.rglob("*"):
+        if path.is_dir():
+            init_file = path / "__init__.py"
+            if not init_file.exists():
+                init_file.touch()

pyside_cli-0.1.1/cli/cache.py

@@ -0,0 +1,24 @@
+import json
+import logging
+import os
+
+
+def load_cache():
+    """load cache from .cache/assets.json"""
+    cache = {}
+    if not os.path.exists('.cache'):
+        os.makedirs('.cache')
+    if os.path.exists('.cache/assets.json'):
+        logging.info('Cache found.')
+        with open('.cache/assets.json', 'r') as f:
+            cache = json.load(f)
+    if not cache:
+        logging.info('No cache found.')
+    return cache
+
+
+def save_cache(cache):
+    # save cache
+    with open('.cache/assets.json', 'w') as f:
+        json.dump(cache, f, indent=4)
+    logging.info('Cache saved.')

pyside_cli-0.1.1/cli/create.py

@@ -0,0 +1,46 @@
+import logging
+import shutil
+import subprocess
+from pathlib import Path
+
+import toml
+from glom import assign
+
+
+def create(name: str):
+    dst = name
+    if name == '.':
+        name = Path.cwd().name
+        dst = '.'
+
+    logging.info(f"Creating ...")
+
+    rt = subprocess.run([
+        'git',
+        'clone',
+        'https://github.com/SHIINASAMA/pyside_template.git',
+        dst
+    ])
+    if rt.returncode:
+        logging.error('Failed to clone template')
+        return
+
+    project_path = Path(dst)
+    pyproject_file = project_path / 'pyproject.toml'
+    data = toml.load(pyproject_file)
+    assign(data, 'project.name', name)
+    with pyproject_file.open('w', encoding='utf-8') as f:
+        toml.dump(data, f)
+
+    git_dir = project_path / '.git'
+    shutil.rmtree(git_dir)
+
+    subprocess.run(
+        [
+            'git',
+            'init'
+        ],
+        cwd=project_path
+    )
+
+    logging.info(f"Project {name} created successfully.")

pyside_cli-0.1.1/cli/git.py

@@ -0,0 +1,15 @@
+import subprocess
+
+
+def get_last_tag(default="0.0.0.0") -> str:
+    """Get the last git tag as version, or return default if not found."""
+    try:
+        tag = subprocess.check_output(
+            ["git", "describe", "--tags", "--abbrev=0", "--first-parent"],
+            stderr=subprocess.DEVNULL,
+            text=True
+        ).strip()
+    except subprocess.CalledProcessError:
+        return default
+
+    return tag if tag else default

pyside_cli-0.1.1/cli/glob.py

@@ -0,0 +1,42 @@
+import logging
+import os
+from pathlib import Path
+
+
+def glob_files():
+    root = Path("app")
+    assets_dir = root / "assets"
+    i18n_dir = root / "i18n"
+    exclude_dirs = [
+        root / "resources",
+        root / "test"
+    ]
+
+    asset_list = []
+    i18n_list = []
+    source_list = []
+    ui_list = []
+
+    for path in root.rglob("*"):
+        if any(ex in path.parents for ex in exclude_dirs):
+            continue
+
+        if assets_dir in path.parents and os.path.isfile(path):
+            asset_list.append(path)
+            continue
+
+        if i18n_dir in path.parents and os.path.isfile(path):
+            i18n_list.append(path)
+            continue
+
+        if path.suffix == ".py":
+            source_list.append(path)
+        elif path.suffix == ".ui":
+            ui_list.append(path)
+
+    logging.debug("Source list: %s", [str(x) for x in source_list])
+    logging.debug("UI list: %s", [str(x) for x in ui_list])
+    logging.debug("Asset list: %s", [str(x) for x in asset_list])
+    logging.debug("I18n list: %s", [str(x) for x in i18n_list])
+
+    return asset_list, i18n_list, source_list, ui_list

pyside_cli-0.1.1/cli/pyproject.py

@@ -0,0 +1,31 @@
+import sys
+
+import glom
+import toml
+
+
+def load_pyproject():
+    """get and build vars from pyproject.toml
+     1. nuitka command options
+     2. enabled languages list"""
+    with open("pyproject.toml") as f:
+        data = toml.load(f)
+    config = glom.glom(data, "tool.build", default={})
+    platform_config = glom.glom(data, f"tool.build.{sys.platform}", default={})
+    config.update(platform_config)
+
+    nuitka_cmd = ""
+    for k, v in config.items():
+        if isinstance(v, list) and v:
+            cmd = f"--{k}={','.join(v)} "
+            nuitka_cmd += cmd
+        if isinstance(v, str) and v != "":
+            cmd = f"--{k}={v} "
+            nuitka_cmd += cmd
+        if type(v) is bool and v:
+            cmd = f"--{k} "
+            nuitka_cmd += cmd
+
+    lang_list = glom.glom(data, "tool.build.i18n.languages", default=[])
+
+    return nuitka_cmd, lang_list

pyside_cli-0.1.1/cli/pytest.py

@@ -0,0 +1,8 @@
+import logging
+from os import system
+
+
+def run_test(args):
+    cmd = 'pytest app ' + (" ".join(args.backend_args))
+    logging.debug(cmd)
+    return system(cmd)

pyside_cli-0.1.1/pyproject.toml

@@ -0,0 +1,19 @@
+[project]
+name = "pyside-cli"
+version = "0.1.1"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.8"
+dependencies = [
+    "glom>=24.11.0",
+    "nuitka>=2.7.16",
+    "pyside6>=6.6.3.1",
+    "toml>=0.10.2",
+]
+
+[project.scripts]
+pyside-cli = "cli.__main__:main"
+
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"

pyside_cli-0.1.1/pyside_cli.egg-info/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.1
+Name: pyside-cli
+Version: 0.1.1
+Summary: Add your description here
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: glom>=24.11.0
+Requires-Dist: nuitka>=2.7.16
+Requires-Dist: pyside6>=6.6.3.1
+Requires-Dist: toml>=0.10.2
+
+# CLI for PySide Template
+
+## Quick Overview
+
+This is a companion CLI for **pyside\_template** (not an official PySide tool).
+
+It helps you quickly create a template project:
+
+```bash
+mkdir app && cd app
+pip install pyside-cli
+pys-cli --create .
+```
+
+You can also build the project or run tests with a single command.  
+Note: running tests requires **pytest**.
+
+```bash
+pys-cli --all --onefile # for build
+pys-cli --test          # for testing
+```
+
+## Links
+
+-   [PyPI - pyside-cli](https://pypi.org/project/pyside-cli/)
+    
+-   [pyside\_template](https://github.com/SHIINASAMA/pyside_template)
+    

pyside_cli-0.1.1/pyside_cli.egg-info/SOURCES.txt

@@ -0,0 +1,21 @@
+README.md
+pyproject.toml
+cli/__init__.py
+cli/__main__.py
+cli/args.py
+cli/cache.py
+cli/create.py
+cli/git.py
+cli/glob.py
+cli/pyproject.py
+cli/pytest.py
+cli/builder/__init__.py
+cli/builder/build.py
+cli/builder/nuitka.py
+cli/builder/qt.py
+pyside_cli.egg-info/PKG-INFO
+pyside_cli.egg-info/SOURCES.txt
+pyside_cli.egg-info/dependency_links.txt
+pyside_cli.egg-info/entry_points.txt
+pyside_cli.egg-info/requires.txt
+pyside_cli.egg-info/top_level.txt

pyside_cli-0.1.1/pyside_cli.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pyside_cli-0.1.1/pyside_cli.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pyside-cli = cli.__main__:main

pyside_cli-0.1.1/pyside_cli.egg-info/requires.txt

@@ -0,0 +1,4 @@
+glom>=24.11.0
+nuitka>=2.7.16
+pyside6>=6.6.3.1
+toml>=0.10.2

pyside_cli-0.1.1/pyside_cli.egg-info/top_level.txt

@@ -0,0 +1 @@
+cli

pyside_cli-0.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+