Metadata-Version: 2.1
Name: PyamlQt
Version: 0.3.1
Summary: PyQt6 configuration in yaml format providing the most simple script.
Home-page: https://github.com/Ar-Ray-code/PyamlQt
Author: Ar-Ray-code
Author-email: ray255ar@gmail.com
License: GPLv3
Project-URL: Source, https://github.com/Ar-Ray-code/PyamlQt
Project-URL: Tracker, https://github.com/Ar-Ray-code/PyamlQt/issues
Description: # PyamlQt（ぴゃむるきゅーと）
        
        [![PyPI version](https://badge.fury.io/py/PyamlQt.svg)](https://badge.fury.io/py/PyamlQt)
        
        - [Zenn「最もシンプルなGUI設計パッケージPyamlQtについて」](https://zenn.dev/array/articles/9617ae0bbd8a80)
        
        PyQt6 configuration in yaml format providing the most simple script.
        
        ## Requirements
        
        - yaml
        - PyQt6, ( PyQt5 )
        
        ## Installation
        
        ```bash
        pip install PyamlQt
        ```
        
        <!-- ```bash
        git clone https://github.com/Ar-Ray-code/PyamlQt.git
        cd PyamlQt
        pip3 install -v -e . 
        ``` -->
        
        ## Demo
        
        ```bash
        python3 examples/chaos.py
        ```
        
        ## Template
        
        See `examples/simple_gui.py`.
        
        ```python
        import sys
        import os
        
        from pyamlqt.mainwindow import PyamlQtWindow
        from PyQt6.QtWidgets import QApplication
        
        class MainWindow(PyamlQtWindow):
            def __init__(self):
                self.number = 0
                yaml_path = os.path.join(os.path.dirname(__file__), "../yaml/chaos.yaml")
                super().__init__(yaml_path)
                # your code -------------------------
                # ************ #
                # -----------------------------------
                self.show()
        
        if __name__ == '__main__':
            app = QApplication(sys.argv)
            window = MainWindow()
            sys.exit(app.exec())
        ```
        
        <!-- Run `python3 <path-to-script>/simple_gui.py`. -->
        ![](image/simple-gui-480p.png)
        
        ## Test YAML 📝
        
        `pyamlqt_yaml` is preview feature app.
        
        ```bash
        pyamlqt_yaml <yaml-file-path>
        # pyamlqt_yaml PyamlQt/yaml/chaos.yaml
        ```
        
        ## Elements (dev)
        In yaml, you can add the following elements defined in PyQt.Widgets This may be added in the future.
        
        - pushbutton : definition of QPushButton
        - qlabel : definition of QLabel 
        - qlcdnumber : definition of QLCDNumber
        - qprogressbar : definition of QProgressBar
        - qlineedit : definition of QLineEdit
        - qcheckbox : definition of QCheckbox
        - qslider : definition of QSlider
        - qspinbox : definition of QSpinBox
        - qcombobox : definition of QCombobox
        - image : definition of QLabel (using image path)
        - stylesheet : definition of Stylesheet (define as QLabel and `setHidden=True`)
        
        ### YAML format
        
        PyamlQt defines common elements for simplicity. Not all values need to be defined, but if not set, default values will be applied
        
        ```yaml
        WINDOW: # unique key (Define key)
          type: window
          x: 0
          y: 0
          width: 800
          height: 720
          title: "example"
        
        slider2: # keyname
          type: qslider # QWidgets
          x_center: 500 # x center point
          y_center: 550 # y center point
          rect:
            width: 200 # QWidgets width
            height: 50 # QWidgets height
          max: 100 # QObject max value
          min: 0 # QObject min value
          default: 70 # QObject set default value
          text: "Slider" # Set Text
          style: # Setting style using stylesheet (css)
            font: 30px # font size
            color: #ff0000 # Color
            font-family: Ubuntu # font-family
          items: # Selectable items( Combobox's option )
            - a
            - b
            - c
        ```
        
        ### PyQt5 Mode
        If you want to use PyQt5, you have to change the `qt6_switch.py` file.
        
        - Open the file and change the `qt6_mode` variable to `False`.
        - `pip install PyQt5`
        - `pip install .`
        
Keywords: PyQt yaml
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.8
Description-Content-Type: text/markdown
