Skip to content

Examples

Usage examples and scenarios for ezqt_app workflows.

Overview

EzQt App focuses on project bootstrap and app-shell composition. Examples below cover the most common workflows.

Available Example Scenarios

Scenario Description Related API
Bootstrap project Generate app/config/theme/translations ezqt init, init(...)
Custom bin path Generate assets in a custom directory init(bin_path=...)
Access app resources Use AppIcons/AppImages after init shared.resources
Start app shell Create and show EzQt_App window EzApplication, EzQt_App
Manage language Switch language and register UI text translation helpers
Theme workflow Apply and switch theme at runtime ThemeService, settings panel

Running Examples

With Python

python -c "from ezqt_app import init; print(init())"

With CLI

ezqt init --verbose
ezqt test --unit
ezqt docs --serve

Code Examples

Bootstrap and Launch

Minimal application lifecycle:

import sys
from ezqt_app import EzApplication, EzQt_App, init

init(mk_theme=True)
app = EzApplication(sys.argv)
window = EzQt_App()
window.show()
sys.exit(app.exec())

Bootstrap with Options

Control what gets generated during initialization:

from ezqt_app import init

# Generate all assets (theme, config, translations)
summary = init(mk_theme=True, verbose=True)
print(summary)

# Place generated assets under binaries/ instead of the default bin/
summary = init(bin_path="binaries")

Access App Icons and Images After Bootstrap

AppIcons and AppImages are populated by init() from the generated bin/app_icons.py and bin/app_images.py files. Always import them after init() has run:

from ezqt_app import init
from ezqt_app.shared.resources import AppIcons, AppImages

init()  # generates bin/app_icons.py and bin/app_images.py

# Access Qt resource paths
icon_path = AppIcons.cil_home        # ":/icons/cil-home.png"
logo_path = AppImages.logo_placeholder  # ":/images/logo-placeholder.jpg"

Import order matters

Importing AppIcons or AppImages at module top-level before init() runs captures None and the variable is never updated. Always call init() first, or access the symbols through the module:

    from ezqt_app.shared import resources

    init()
    icon_path = resources.AppIcons.cil_home  # always resolves to the live value

Add Pages to the App Shell

Register menus/pages at startup:

import sys
from ezqt_app import EzApplication, EzQt_App, init

init()
app = EzApplication(sys.argv)
window = EzQt_App()

home_page = window.add_menu("Home", "home")
settings_page = window.add_menu("Settings", "settings")
analytics_page = window.add_menu("Analytics", "analytics")

window.show()
sys.exit(app.exec())

Change Language at Runtime

Switch the application language programmatically:

from ezqt_app.services.translation import change_language_by_code

# Switch to French
change_language_by_code("fr")

# Switch back to English
change_language_by_code("en")

Disable Auto-Translation

Control whether external translation providers are called:

window = EzQt_App()

# Disable external API calls while keeping local TS support
window.enable_auto_translation(False)

window.show()

Apply a Custom Theme

All .qss files placed under bin/themes/ are loaded automatically — no file name needs to be passed explicitly:

import sys
from ezqt_app import EzApplication, EzQt_App, init

init()
app = EzApplication(sys.argv)
window = EzQt_App()  # themes loaded from bin/themes/ automatically
window.show()
sys.exit(app.exec())

Deprecated argument

EzQt_App(theme_file_name=...) still compiles but emits a deprecation warning and has no effect. Remove it from your code.

Access Config Service

Read configuration values at runtime:

from ezqt_app.services.settings import get_settings_service

settings = get_settings_service()
theme = settings.get("theme", default="dark")
language = settings.get("language", default="en")

Advanced Example: Full App with Pages and Language Switch

import sys
from PySide6.QtWidgets import QApplication
from ezqt_app import EzApplication, EzQt_App, init
from ezqt_app.services.translation import change_language_by_code


class MyApp:
    def __init__(self):
        init(mk_theme=True, verbose=False)
        self.app = EzApplication(sys.argv)
        self.window = EzQt_App()  # theme_file_name removed — deprecated

        # Register pages
        self.window.add_menu("Dashboard", "dashboard")
        self.window.add_menu("Reports", "reports")
        self.window.add_menu("Settings", "settings")

        # Start in French
        change_language_by_code("fr")

    def run(self) -> int:
        self.window.show()
        return self.app.exec()


if __name__ == "__main__":
    app = MyApp()
    sys.exit(app.run())

Suggested Real-World Scenarios

  • Bootstrap a new desktop project with ezqt init
  • Add pages with EzQt_App.add_menu(...)
  • Customize themes using bin/themes/main_theme.qss
  • Switch UI language using translation service helpers
  • Run tests by scope with python tests/run_tests.py --type unit