robotframework-dialogsplus 0.1.0__tar.gz

robotframework_dialogsplus-0.1.0/.gitignore

@@ -0,0 +1,78 @@
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+utests/.pytest_cache/
+utests/.coverage
+utests/coverage.xml
+utests/htmlcov/
+
+# Translations
+*.mo
+*.pot
+
+# IPython
+profile_default/
+ipython_config.py
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Environments
+.venv
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# ruff
+.ruff_cache/
+
+
+
+# Robot Framework output files in atests/
+results
+.vscode

robotframework_dialogsplus-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13

robotframework_dialogsplus-0.1.0/PKG-INFO

@@ -0,0 +1,37 @@
+Metadata-Version: 2.4
+Name: robotframework-dialogsplus
+Version: 0.1.0
+Summary: A drop-in enhancement for Robot Framework's Dialogs library with modern UI and extended user interaction keywords.
+Author-email: Alpha-Centauri-00 <Alpha@Centauri.c0m>
+License-Expression: MIT
+Requires-Python: >=3.10
+Requires-Dist: customtkinter>=5.2.2
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: robotframework>=7.3.2
+Description-Content-Type: text/markdown
+
+# DialogsPlus
+A drop-in enhancement for Robot Framework's Dialogs library with modern UI and extended user interaction keywords.
+
+### ⚠️ Known Limitations
+
+- Not supported in headless environments such as CI/CD pipelines (e.g., Jenkins, GitHub Actions)
+
+
+**DialogsPlus** is a user-friendly and fully customizable dialog library for [Robot Framework](https://robotframework.org/), built on top of [`customtkinter`](https://github.com/TomSchimansky/CustomTkinter). It extends the built-in dialog functionality with rich GUI dialogs that are **stylish**, **modern**, and **configurable** via a simple `config.yaml` file.
+
+---
+
+## ✨ Features
+
+- Easy-to-use dialogs for user interaction during test runs
+- Full GUI-based interface using `customtkinter`
+- Customizable look and feel (colors, fonts, sizes, etc.) via `config.yaml`
+- Drop-in replacement for standard Robot Framework dialogs
+- Supports dynamic sizing based on input fields or options
+
+---
+
+
+
+Pull requests are welcome! More info coming soon.

robotframework_dialogsplus-0.1.0/README.md

@@ -0,0 +1,25 @@
+# DialogsPlus
+A drop-in enhancement for Robot Framework's Dialogs library with modern UI and extended user interaction keywords.
+
+### ⚠️ Known Limitations
+
+- Not supported in headless environments such as CI/CD pipelines (e.g., Jenkins, GitHub Actions)
+
+
+**DialogsPlus** is a user-friendly and fully customizable dialog library for [Robot Framework](https://robotframework.org/), built on top of [`customtkinter`](https://github.com/TomSchimansky/CustomTkinter). It extends the built-in dialog functionality with rich GUI dialogs that are **stylish**, **modern**, and **configurable** via a simple `config.yaml` file.
+
+---
+
+## ✨ Features
+
+- Easy-to-use dialogs for user interaction during test runs
+- Full GUI-based interface using `customtkinter`
+- Customizable look and feel (colors, fonts, sizes, etc.) via `config.yaml`
+- Drop-in replacement for standard Robot Framework dialogs
+- Supports dynamic sizing based on input fields or options
+
+---
+
+
+
+Pull requests are welcome! More info coming soon.

robotframework_dialogsplus-0.1.0/atests/config.yaml

@@ -0,0 +1,14 @@
+title: "Custom Dialog"
+width: 400
+height: 200
+theme: "green"
+appearance_mode: "light"
+button_fg_color: "#aaa"
+
+# 
+button_width: 150
+button_height: 40
+label_font: ["Calibri", 14]
+entry_height: 30
+entry_width: 300
+spacing: 12

robotframework_dialogsplus-0.1.0/atests/testing.robot

@@ -0,0 +1,87 @@
+*** Settings ***
+Library           DialogsPlus    #config=D:/robotframework-dialogsplus/atests/config.yaml
+Library           OperatingSystem
+
+Suite Setup       Set Log Level    level=TRACE
+Test Setup        Log Test Case Name
+
+
+*** Keywords ***
+Log Test Case Name
+    [Tags]    robot:flatten
+    Log    <p style="background-color: #06bdb1; font-weight: bold; display: inline-block; padding: 4px;">*** Running Test: ${TEST NAME} ***</p>    html=${True}
+
+
+*** Variables ***
+
+@{fields_val}     username    password    email    phone
+@{fields}         username    password
+&{default_val}    username=admin    password=P@55    phone=1234567
+&{default}        username=user1    password=P@55
+
+*** Test Cases ***
+
+Get Value From User Default
+    ${result}    Get Value From User    prompt=Enter your name:    default=Robot framework
+    Should Be Equal    ${result}    Robot framework
+
+Run Manual Steps Executes
+    ${steps}    Create List    Open the app    Click Start button    Verify status
+    Run Manual Steps    ${steps}
+    Log    Manual steps executed successfully
+
+Count Down Runs
+    Count Down    3
+    Log    Countdown executed for 3 seconds
+
+Get Confirmation Returns Boolean
+    ${result}    Get Confirmation    Are you sure?
+    Should Be True    isinstance(${result}, bool)
+
+Get Multi Value
+    ${result}    Get Multi Value    ${fields}    default=${default}
+    Should Be Equal    ${result}[username]    user1
+
+
+Get Multi Value Multiple Fields
+    ${result}    Get Multi Value    ${fields_val}    default=${default_val}
+    Should Be Equal    ${result}[password]    P@55
+    Should Be Equal    ${result}[phone]       1234567
+
+Choose Single XML File
+    ${XML_FILETYPES}    Evaluate    [("xml files", "*.xml")]
+    ${result}=    Choose File    message=Select Single XML File    filetypes=${XML_FILETYPES}
+    Should Contain    ${result}    .xml
+
+Choose Multiple HTML Files
+    ${HTML_FILETYPES}    Evaluate    [("HTML", "*.html")]
+    ${result}=    Choose File    message=Select Multiple HTML Files    filetypes=${HTML_FILETYPES}   multiple=True
+    Should Contain    ${result}[0]    .html
+
+Choose Folder Test
+    ${result}=    Choose Folder    message=Select Any Directory
+    Directory Should Exist    ${result}
+
+Single Ceckbox Test
+    ${r}    Confirm With Checkbox    message=Do you accept the terms?    checkbox_text=I accept, no matter what!
+    Should Be True    ${r}
+
+Select Many Checkbox Test
+    ${r}    Select Options With Checkboxes    message=Select as much as you want   options=${fields_val}
+    Should Not Be True    ${r}[username]
+    Should Not Be True    ${r}[password]
+    Should Not Be True    ${r}[email]
+    Should Not Be True    ${r}[phone]
+
+Select Many Checkbox With Defaults Test
+    @{Contacts}    Create List        Email    SMS    Phone    Slack    Discord
+    ${selected}=    Select Options With Checkboxes
+    ...    message=Choose your preferences
+    ...    options=${Contacts}
+    ...    defaults=Email,SMS        # Default Selected!
+    
+    Should Be True        ${selected}[Email]
+    Should Be True        ${selected}[SMS]
+    Should Not Be True    ${selected}[Phone]
+    Should Not Be True    ${selected}[Slack]
+    Should Not Be True    ${selected}[Discord]

robotframework_dialogsplus-0.1.0/pyproject.toml

@@ -0,0 +1,31 @@
+[project]
+name = "robotframework-dialogsplus" 
+version = "0.1.0"
+description = "A drop-in enhancement for Robot Framework's Dialogs library with modern UI and extended user interaction keywords."
+readme = "README.md"
+authors = [
+    { name = "Alpha-Centauri-00", email = "Alpha@Centauri.c0m" }
+]
+requires-python = ">=3.10"
+license = "MIT"
+
+dependencies = [
+    "customtkinter>=5.2.2",
+    "pyyaml>=6.0.3",
+    "robotframework>=7.3.2",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/DialogsPlus"]
+
+[dependency-groups]
+dev = [
+    "robotframework-tidy>=4.18.0",
+]
+[tool.ruff]
+ignore = ["E722"]
+

robotframework_dialogsplus-0.1.0/src/DialogsPlus/__init__.py

@@ -0,0 +1,5 @@
+# src/DialogsPlus/__init__.py
+
+from .dialogsplus import DialogsPlus
+
+__all__ = ["DialogsPlus"]  

robotframework_dialogsplus-0.1.0/src/DialogsPlus/dialogsplus.py

@@ -0,0 +1,90 @@
+from robot.api.deco import keyword
+import os
+from DialogsPlus.utils.config import DialogConfig
+from DialogsPlus.widgets.wrappers import ( GetValueFromUserDialog, 
+                                          ExecuteManualStepDialog, 
+                                          CountdownDialogRunner,
+                                          GetConfirmationFromUser, 
+                                          MultiValueInput,
+                                          ChooseFromFileDialog,
+                                          ChooseFolderDialog,
+                                          ConfirmWithCheckbox,
+                                          SelectOptionsWithCheckboxes)
+
+
+ROBOT_LIBRARY_SCOPE = 'SUITE'
+
+class DialogsPlus:
+
+    def __init__(self, config=None):
+    
+        if config and os.path.exists(config):
+            self.config = DialogConfig.from_yaml(config)
+        else:
+            self.config = DialogConfig()  # use defaults
+
+    
+    @keyword
+    def get_value_from_user(self, prompt="Enter value:", default=""):
+        return GetValueFromUserDialog.show(prompt,default,config=self.config)
+
+    @keyword
+    def run_manual_steps(self, steps):
+        ExecuteManualStepDialog.run_steps(steps, config=self.config)
+
+    @keyword
+    def count_down(self, seconds):
+        CountdownDialogRunner.show(int(seconds), config=self.config)
+            
+    @keyword
+    def get_confirmation(self, message):
+        return GetConfirmationFromUser.show(message=message,config=self.config)
+    
+    @keyword
+    def get_multi_value(self, fields, default=None):
+        fields_list = fields if isinstance(fields, list) else [fields]
+        calculated_height = 150 + (len(fields_list) * 40) + 60
+        #max_field_length = max(len(field) for field in fields_list)
+        max_field_length = 20
+        calculated_width = 300 + (max_field_length * 8)
+        self.config.height = calculated_height
+        self.config.width = calculated_width
+        return MultiValueInput.run_multival(fields=fields,defaults=default,config=self.config)
+    
+    @keyword
+    def choose_file(self, message="",  filetypes=None, multiple=False):
+        return ChooseFromFileDialog.show( message, filetypes, multiple, self.config)
+
+    @keyword
+    def choose_folder(self, message):
+        return ChooseFolderDialog.show(message, self.config)
+    
+
+    @keyword
+    def confirm_with_checkbox(self, message, checkbox_text="I agree"):
+        return ConfirmWithCheckbox.show(message, checkbox_text, self.config)
+    
+
+    @keyword
+    def select_options_with_checkboxes(self, message, options, defaults=None):
+        """Show multiple checkboxes and return selected options as dictionary."""
+        
+        options_list = options if isinstance(options, list) else options.split('|')
+        
+        # Base sizing
+        num_options = len(options_list)
+        max_option_length = max(len(opt) for opt in options_list)
+        message_length = len(message)
+        
+        # Height: base + checkboxes + some buffer
+        calculated_height = 180 + (num_options * 40)
+        
+        # Width: consider both message and longest option
+        width_from_message = min(600, max(300, message_length * 7))
+        width_from_options = max(300, 200 + (max_option_length * 8))
+        calculated_width = max(width_from_message, width_from_options)
+        
+        self.config.height = calculated_height
+        self.config.width = calculated_width
+        
+        return SelectOptionsWithCheckboxes.show(message, options, defaults, self.config)

robotframework_dialogsplus-0.1.0/src/DialogsPlus/utils/config.py

@@ -0,0 +1,83 @@
+# dialog_config.py
+
+import yaml
+
+class DialogConfig:
+    def __init__(
+        self,
+        title="Robot Framework",
+        width=400,
+        height=150,
+        theme="blue",
+        appearance_mode="system",
+
+        button_width=120,
+        button_height=32,
+        label_font=("Courier New", 16, "bold"),
+        entry_width= 200,
+        entry_height=28,
+        spacing=10,
+        button_fg_color="#06bdb1",
+        button_font=("Courier New", 16, "bold"),
+        label_text_color="white",
+        button_text_color="black",
+        button_hover_color="#57b7b0",
+        entry_font=("Courier New", 14),
+        entry_text_color="white",
+        entry_fg_color="#212121",
+        entry_border_color="#46fff4",
+        frame_fg_color = "transparent",
+        progress_bar_width = 300,
+        progress_bar_height = 12,
+        progress_bar_color = "#00c0b5",
+
+        
+    ):
+        self.title = title
+        self.width = width
+        self.height = height
+        self.theme = theme
+        self.appearance_mode = appearance_mode
+
+        self.button_width = button_width
+        self.button_height = button_height
+        self.label_font = label_font
+        self.entry_width = entry_width
+        self.entry_height = entry_height
+        self.spacing = spacing
+        self.button_fg_color=button_fg_color
+        self.button_font = button_font
+        self.label_text_color = label_text_color
+        self.button_text_color = button_text_color
+        self.button_hover_color = button_hover_color
+        self.entry_font = entry_font
+        self.entry_text_color = entry_text_color
+        self.entry_fg_color = entry_fg_color
+        self.entry_border_color = entry_border_color
+        self.frame_fg_color = frame_fg_color
+        self.progress_bar_width = progress_bar_width
+        self.progress_bar_height = progress_bar_height
+        self.progress_bar_color = progress_bar_color
+
+
+    @classmethod
+    def from_yaml(cls, path: str):
+        print(f"[DEBUG] Received config path: {path}")
+        with open(path, "r", encoding="utf-8") as f:
+            data = yaml.safe_load(f)
+
+        return cls(
+            title=data.get("title", "Dialog"),
+            width=data.get("width", 300),
+            height=data.get("height", 150),
+            theme=data.get("theme", "blue"),
+            appearance_mode=data.get("appearance_mode", "system"),
+
+            button_width=data.get("button_width", 120),
+            button_height=data.get("button_height", 32),
+            label_font=tuple(data.get("label_font", ("Arial", 12))),
+            entry_height=data.get("entry_height", 28),
+            entry_width=data.get("entry_width",60),
+            spacing=data.get("spacing", 10),
+            button_fg_color=data.get("button_fg_color", "#06bdb1")
+        )

robotframework_dialogsplus-0.1.0/src/DialogsPlus/widgets/base.py

@@ -0,0 +1,169 @@
+import customtkinter as ctk
+from customtkinter import BooleanVar, IntVar
+from DialogsPlus.utils.config import DialogConfig
+from tkinter import filedialog
+import os
+
+
+# Export for use in other modules
+__all__ = [
+    'BaseDialogRunner',
+    'BaseDialog',
+    'ctk',
+    'BooleanVar',
+    'filedialog',
+    'IntVar'
+]
+
+class BaseDialogRunner:
+    _theme_initialized = False
+    
+    @staticmethod
+    def _center_window(app, config):
+        app.update_idletasks()
+        
+        screen_width = app.winfo_screenwidth()
+        screen_height = app.winfo_screenheight()
+        
+        x = (screen_width - config.width) // 2
+        y = (screen_height - config.height) // 2       
+        app.geometry(f"{config.width}x{config.height}+{x}+{y}")
+    
+    @staticmethod
+    def create_app(config: DialogConfig):
+        # Initialize theme once on first dialog creation
+        if not BaseDialogRunner._theme_initialized:
+            ctk.set_appearance_mode(config.appearance_mode)
+            ctk.set_default_color_theme(config.theme)
+            BaseDialogRunner._theme_initialized = True
+        
+        app = ctk.CTk()
+        app.title(config.title)
+
+        icon_path = os.path.join(os.path.dirname(__file__), "assets", "robot.ico")
+        try:
+            app.iconbitmap(icon_path)
+        except (FileNotFoundError, Exception):
+            pass
+
+        BaseDialogRunner._center_window(app, config)
+        return app
+
+    @staticmethod
+    def run_dialog(ui_builder_func, config: DialogConfig):
+        app = BaseDialogRunner.create_app(config)
+        ui_builder_func(app)
+        app.mainloop()
+        
+        app.withdraw()
+        
+        try:
+            after_ids = app.tk.call('after', 'info')
+            for after_id in after_ids:
+                try:
+                    app.after_cancel(after_id)
+                except:
+                    pass
+        except:
+            pass
+        
+        app.update_idletasks()
+        
+        try:
+            app.quit()
+        except:
+            pass
+        
+        try:
+            app.destroy()
+        except:
+            pass
+
+
+class BaseDialog:
+    
+    def __init__(self, config=None):
+        self.config = config if config else DialogConfig()
+        self.result = {}
+    
+    def create_button(self, parent, text, command, **kwargs):
+        """Create a button with config styling"""
+        return ctk.CTkButton(
+            parent,
+            text=text,
+            command=command,
+            font=self.config.button_font,
+            fg_color=self.config.button_fg_color,
+            text_color=self.config.button_text_color,
+            hover_color=self.config.button_hover_color,
+            width=kwargs.get('width', self.config.button_width),
+            height=kwargs.get('height', self.config.button_height),
+            **{k: v for k, v in kwargs.items() if k not in ['width', 'height']}
+        )
+
+    def create_label(self, parent, text, **kwargs):
+        """Create a label with config styling"""
+        return ctk.CTkLabel(
+            parent,
+            text=text,
+            font=self.config.label_font,
+            text_color=self.config.label_text_color,
+            anchor=kwargs.get('anchor', "center"),
+            justify=kwargs.get('justify', "left"),
+            wraplength=kwargs.get('wraplength', 0),
+            **{k: v for k, v in kwargs.items() if k not in ['anchor', 'justify', 'wraplength']}
+        )
+    
+    def create_entry(self, parent, **kwargs):
+        """Create an entry with consistent styling from config"""
+        return ctk.CTkEntry(
+            parent,
+            width=kwargs.get('width', self.config.entry_width),
+            height=kwargs.get('height', self.config.entry_height),
+            font=kwargs.get('font', self.config.entry_font),
+            text_color=kwargs.get('text_color', self.config.entry_text_color),
+            fg_color=kwargs.get('fg_color', self.config.entry_fg_color),
+            border_color=kwargs.get('border_color', self.config.entry_border_color),
+            **{k: v for k, v in kwargs.items() if k not in ['width', 'height', 'font', 'text_color', 'fg_color', 'border_color']}
+        )
+    
+    def create_frame(self, parent, **kwargs):
+        return ctk.CTkFrame(
+            parent,
+            fg_color=kwargs.get('fg_color', self.config.frame_fg_color),
+            **{k: v for k, v in kwargs.items() if k not in ['fg_color']}  # ← Add this
+        )
+        
+    def create_progress_bar(self, parent, **kwargs):
+        return ctk.CTkProgressBar(
+            parent,
+            width=kwargs.get('width', self.config.progress_bar_width),
+            height=kwargs.get('height', self.config.progress_bar_height),
+            progress_color=kwargs.get('progress_color', self.config.progress_bar_color),
+            **{k: v for k, v in kwargs.items() if k not in ['width', 'height', 'progress_color']}
+        )
+    
+    def create_checkbox(self, parent, text="", **kwargs):
+        """Create a checkbox with consistent styling from config"""
+        return ctk.CTkCheckBox(
+            parent,
+            text=text,
+            font=kwargs.get('font', self.config.label_font),
+            text_color=kwargs.get('text_color', self.config.label_text_color),
+            fg_color=kwargs.get('fg_color', self.config.button_fg_color),
+            hover_color=kwargs.get('hover_color', self.config.button_hover_color),
+            **{k: v for k, v in kwargs.items() if k not in ['font', 'text_color', 'fg_color', 'hover_color']}
+        )
+
+
+# testing this shit
+    
+    def show(self):
+        def ui(app):
+            self.build_ui(app)
+        
+        BaseDialogRunner.run_dialog(ui, self.config)
+        return self.result
+    
+    def build_ui(self, app):
+        raise NotImplementedError