Welcome to the Guitares documentation!

Guitares is a Python package for building configurable Graphical User Interfaces (GUIs) using the PyQt5 framework. GUI configurations can be defined programmatically, but are typically provided by the developer in YAML configuration files.

A Guitares GUI consists of a main window (with optional drop-down menu) that contains one or more UI elements. Guitares currently supports the following UI elements (or widgets):

• Tab panels

• Frames

• Edit boxes

• Text

• Pop-up menus

• List boxes

• Check boxes

• Radio buttons

• Sliders

• Push buttons

• Web views

• MapBox maps

Please see the Elements section for more information about each UI element.

Check out the Getting started section for instructions on how to get started!

Note

This project is under active development.

Contents

• Getting started
  • Installation
• A Very Simple Example
  • The configuration file (hello.yml)
  • The app module (app.py)
  • The callback module (callbacks.py)
  • The run module (hello.py)
• Elements
  • Edit box
  • Text
  • Push button
  • Pop-up menu
  • List box
  • Slider
  • Tab panel
  • Frame
• Menu
• Variables
  • Accessing variables
• Callbacks
• Positioning elements
• The GUI Object
• Configuration
• Element dependencies
• Using tab panels
• Using MapBox
• Using Style Sheets
• More examples
  • Simple Calculator
  • News Website Comparison
  • MapBox