@ -18,33 +18,33 @@ Table of Contents
-----------------
- [Gooey ](#gooey )
- [Table of Contents ](#table-of-contents )
- [Quick Start ](#quick-start )
- [Installation instructions ](#installation-instructions )
- [Table of contents ](#table-of-contents )
- [Latest Update ](#latest-update )
- [Quick Start ](#quick-start )
- [Installation Instructions ](#installation-instructions )
- [Usage ](#usage )
- [Examples ](#examples )
- [What is it? ](#what-is-it )
- [Why? ](#why )
- [Who is this for? ](#who-is-this-for )
- [How does it work? ](#how-does-it-work )
- [Mappings: ](#mappings )
- [GooeyParser ](#gooeyparser )
- [Internationalization ](#internationalization )
- [Global Configuration ](#global-configuration )
- [Layout Customization ](#layout-customization )
- [Run Modes ](#run-modes )
- [Advanced ](#advanced )
- [What It Is ](#what-is-it )
- [Why Is It ](#why )
- [Who is this for ](#who-is-this-for )
- [How does it work ](#how-does-it-work )
- [Internationalization ](#internationalization )
- [Global Configuration ](#global-configuration )
- [Layout Customization ](#layout-customization )
- [Run Modes ](#run-modes )
- [Full/Advanced ](#advanced )
- [Basic ](#basic )
- [No Config ](#no-config )
- [Menus ](#menus )
- [Input Validation ](#input-validation )
- [Using Dynamic Values ](#using-dynamic-values )
- [Showing Progress ](#showing-progress )
- [Menus ](#menus )
- [Input Validation ](#input-validation )
- [Using Dynamic Values ](#using-dynamic-values )
- [Showing Progress ](#showing-progress )
- [Elapsed / Remaining Time ](#elapsed--remaining-time )
- [Customizing Icons ](#customizing-icons )
- [Packaging ](#packaging )
- [Screenshots ](#screenshots )
- [Wanna help? ](#wanna-help )
- [Customizing Icons ](#customizing-icons )
- [Packaging ](#packaging )
- [Screenshots ](#screenshots )
- [Contributing ](#wanna-help )
- [Image Credits ](#image-credits )
@ -157,16 +157,16 @@ At run-time, it parses your Python script for all references to `ArgumentParser`
Gooey does its best to choose sensible defaults based on the options it finds. Currently, `ArgumentParser._actions` are mapped to the following `WX` components.
| Parser Action | Widget | Example |
| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------- ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| store | TextCtrl | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/f54e9f5e-07c5-11e5-86e5-82f011c538cf.png" / > |
| store_const | CheckBox | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/f538c850-07c5-11e5-8cbe-864badfa54a9.png" / > |
| store_true | CheckBox | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/f538c850-07c5-11e5-8cbe-864badfa54a9.png" / > |
| store_False | CheckBox | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/f538c850-07c5-11e5-8cbe-864badfa54a9.png" / > |
| append | TextCtrl | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/f54e9f5e-07c5-11e5-86e5-82f011c538cf.png" / > |
| count | DropDown | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/f53ccbe4-07c5-11e5-80e5-510e2aa22922.png" / > |
| Mutually Exclusive Group | RadioGroup | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/f553feb8-07c5-11e5-9d5b-eaa4772075a9.png" / > |
| choice | DropDown | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/f54e4da6-07c5-11e5-9e66-d8e6d7f18ac6.png" / > |
| Parser Action | Widget | Example |
|:----------------------|-----------|------|
| store | TextCtrl | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/f54e9f5e-07c5-11e5-86e5-82f011c538cf.png" / > |
| store_const | CheckBox |< img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/f538c850-07c5-11e5-8cbe-864badfa54a9.png" / > |
| store_true | CheckBox | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/f538c850-07c5-11e5-8cbe-864badfa54a9.png" / > |
| store_False | CheckBox| < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/f538c850-07c5-11e5-8cbe-864badfa54a9.png" / > |
| append | TextCtrl | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/f54e9f5e-07c5-11e5-86e5-82f011c538cf.png" / > |
| count | DropDown | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/f53ccbe4-07c5-11e5-80e5-510e2aa22922.png" / > |
| Mutually Exclusive Group | RadioGroup | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/f553feb8-07c5-11e5-9d5b-eaa4772075a9.png" / >
|choice | DropDown | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/f54e4da6-07c5-11e5-9e66-d8e6d7f18ac6.png" / > |
### GooeyParser
@ -200,14 +200,14 @@ However, by dropping in `GooeyParser` and supplying a `widget` name, you can dis
**Custom Widgets:**
| Widget | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| DirChooser, FileChooser, MultiFileChooser, FileSaver, MultiFileSaver | < p align = "center" > < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/f5483b28-07c5-11e5-9d01-1935635fc22d.gif" width = "400" > < / p > |
| DateChooser/TimeChooser | < p align = "center" >< img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/f544756a-07c5-11e5-86d6-862ac146ad35.gif" width = "400" ></ p > < p > Please note that for both of these widgets the values passed to the application will always be in [ISO format ](https://www.wxpython.org/Phoenix/docs/html/wx.DateTime.html#wx.DateTime.FormatISOTime ) while localized values may appear in some parts of the GUI depending on end-user settings.</ p > |
| PasswordField | < p align = "center" > < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/28953722-eae72cca-788e-11e7-8fa1-9a1ef332a053.png" width = "400" > < / p > |
| Listbox |  |
| BlockCheckbox |  < br /> The default InlineCheck box can look less than ideal if a large help text block is present. `BlockCheckbox` moves the text block to the normal position and provides a short-form `block_label` for display next to the control. Use `gooey_options.checkbox_label` to control the label text |
| ColourChooser | < p align = "center" > < img src = "https://user-images.githubusercontent.com/21027844/72672451-0752aa80-3a0f-11ea-86ed-8303bd3e54b5.gif" width = "400" > < / p > |
| Widget | Example |
|----------------|------------------------------|
| DirChooser, FileChooser, MultiFileChooser, FileSaver, MultiFileSaver | < p align = "center" > < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/f5483b28-07c5-11e5-9d01-1935635fc22d.gif" width = "400" > < / p > |
| DateChooser/TimeChooser | < p align = "center" >< img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/f544756a-07c5-11e5-86d6-862ac146ad35.gif" width = "400" ></ p > < p > Please note that for both of these widgets the values passed to the application will always be in [ISO format ](https://www.wxpython.org/Phoenix/docs/html/wx.DateTime.html#wx.DateTime.FormatISOTime ) while localized values may appear in some parts of the GUI depending on end-user settings.</ p > |
| PasswordField | < p align = "center" > < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/28953722-eae72cca-788e-11e7-8fa1-9a1ef332a053.png" width = "400" > < / p > |
| Listbox |  |
| BlockCheckbox |  < br /> The default InlineCheck box can look less than ideal if a large help text block is present. `BlockCheckbox` moves the text block to the normal position and provides a short-form `block_label` for display next to the control. Use `gooey_options.checkbox_label` to control the label text |
| ColourChooser | < p align = "center" > < img src = "https://user-images.githubusercontent.com/21027844/72672451-0752aa80-3a0f-11ea-86ed-8303bd3e54b5.gif" width = "400" > < / p > |
@ -306,9 +306,9 @@ You can achieve fairly flexible layouts with Gooey by using a few simple customi
At the highest level, you have several overall layout options controllable via various arguments to the Gooey decorator.
| `show_sidebar=True` | `show_sidebar=False` | `navigation='TABBED'` | `tabbed_groups=True` |
| ----------------------------------------------------------------------------------------------------------------------- --------------------- | ---------------------------------------------------------------------------------------------------------------------- ---------------------- | ---------------------------------------------------------------------------------------------------------------------- ---------------------- | ---------------------------------------------------------- ---------------------------------------------------------------------------------- |
| < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/34464847-9918fbb0-ee47-11e7-8d5f-0d42631c2bc0.png" width = "400" > | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/35487799-762aa308-0434-11e8-8eb3-1e9fab2d13ae.png" width = "400" > | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/34464835-5ba9b0e4-ee47-11e7-9561-55e3647c2165.png" width = "400" > | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/34464826-2a946ba2-ee47-11e7-92a4-4afeb49dc9ca.png" width = "400" > |
| `show_sidebar=True` | `show_sidebar=False` | `navigation='TABBED'` | `tabbed_groups=True` |
|---------------------|----------------------|----------------------|------------------------|
|< img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/34464847-9918fbb0-ee47-11e7-8d5f-0d42631c2bc0.png" width = "400" > |< img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/35487799-762aa308-0434-11e8-8eb3-1e9fab2d13ae.png" width = "400" > |< img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/34464835-5ba9b0e4-ee47-11e7-9561-55e3647c2165.png" width = "400" > |< img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/34464826-2a946ba2-ee47-11e7-92a4-4afeb49dc9ca.png" width = "400" > |
**Grouping Inputs**
@ -701,7 +701,7 @@ Gooey also supports tracking elapsed / remaining time when progress is used! Thi
```python
@Gooey (progress_regex=r"^progress: (?P< current > \d+)/(?P< total > \d+)$",
progress_expr="current / total * 100",
timing_options = {
timing_options = {
'show_time_remaining':True,
'hide_time_remaining_on_complete':True,
})
@ -743,13 +743,13 @@ Detailed step by step instructions can be found [here](http://chriskiehl.com/art
Screenshots
------------
| Flat Layout | Column Layout | Success Screen | Error Screen | Warning Dialog |
| ------------------------------------------------------------------ ----------------------------------------------------- | ------------------------ ----------------------------------------------------------------------------------------------- | --------------------------------------------------- -------------------------------------------------------------------- | ------------------------------------------------------------------------------ ----------------------------------------- | -------------------------------------- --------------------------------------------------------------------------------- |
| < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/4414e54e-0965-11e5-964b-f717a7adaac6.jpg" > | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/4411b824-0965-11e5-905a-3a2b5df0efb3.jpg" > | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/44165442-0965-11e5-8edf-b8305353285f.jpg" > | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/4410dcce-0965-11e5-8243-c1d832c05887.jpg" > | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/4415432c-0965-11e5-9190-17f55460faf3.jpg" > |
| Flat Layout | Column Layout |Success Screen | Error Screen | Warning Dialog |
|-------------|---------------|---------------|--------------|----------------|
| < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/4414e54e-0965-11e5-964b-f717a7adaac6.jpg" > | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/4411b824-0965-11e5-905a-3a2b5df0efb3.jpg" > | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/44165442-0965-11e5-8edf-b8305353285f.jpg" > | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/4410dcce-0965-11e5-8243-c1d832c05887.jpg" > | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/4415432c-0965-11e5-9190-17f55460faf3.jpg" > |
| Custom Groups | Tabbed Groups | Tabbed Navigation | Sidebar Navigation | Input Validation |
| ------------------------------------------------------------------------ -------------------------------------------------------- | --------------------------- ----------------------------------------------------------------------------------------------------- | -------------------------------------------------------- ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- ------------------------------------------- | ----------------------------------------- --------------------------------------------------------------------------------------- |
| < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/34464824-c044d57a-ee46-11e7-9c35-6e701a7c579a.png" > | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/34464826-2a946ba2-ee47-11e7-92a4-4afeb49dc9ca.png" > | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/34464835-5ba9b0e4-ee47-11e7-9561-55e3647c2165.png" > | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/34464847-9918fbb0-ee47-11e7-8d5f-0d42631c2bc0.png" > | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/34464861-0e82c214-ee48-11e7-8f4a-a8e00721efef.png" > |
| Custom Groups | Tabbed Groups | Tabbed Navigation | Sidebar Navigation | Input Validation |
|-------------|---------------|---------------|--------------|----------------|
| < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/34464824-c044d57a-ee46-11e7-9c35-6e701a7c579a.png" > | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/34464826-2a946ba2-ee47-11e7-92a4-4afeb49dc9ca.png" > | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/34464835-5ba9b0e4-ee47-11e7-9561-55e3647c2165.png" > | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/34464847-9918fbb0-ee47-11e7-8d5f-0d42631c2bc0.png" > | < img src = "https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/34464861-0e82c214-ee48-11e7-8f4a-a8e00721efef.png" > |
Chris
4 years ago