You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

622 lines
30 KiB

10 years ago
7 years ago
10 years ago
10 years ago
9 years ago
7 years ago
10 years ago
9 years ago
9 years ago
9 years ago
10 years ago
9 years ago
6 years ago
6 years ago
9 years ago
10 years ago
6 years ago
6 years ago
6 years ago
9 years ago
9 years ago
9 years ago
10 years ago
9 years ago
7 years ago
9 years ago
7 years ago
9 years ago
9 years ago
10 years ago
9 years ago
10 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
10 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
10 years ago
9 years ago
10 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
7 years ago
7 years ago
9 years ago
10 years ago
9 years ago
9 years ago
9 years ago
9 years ago
10 years ago
6 years ago
9 years ago
6 years ago
9 years ago
6 years ago
9 years ago
9 years ago
6 years ago
9 years ago
6 years ago
9 years ago
6 years ago
6 years ago
6 years ago
6 years ago
10 years ago
9 years ago
9 years ago
10 years ago
10 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
10 years ago
10 years ago
10 years ago
10 years ago
9 years ago
10 years ago
10 years ago
10 years ago
9 years ago
10 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
10 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
10 years ago
9 years ago
6 years ago
9 years ago
10 years ago
6 years ago
9 years ago
10 years ago
9 years ago
  1. Gooey (Beta)
  2. =====
  3. Turn (almost) any Python 2 or 3 Console Program into a GUI application with one line
  4. <p align="center">
  5. <img src="https://cloud.githubusercontent.com/assets/1408720/7904381/f54f97f6-07c5-11e5-9bcb-c3c102920769.png" />
  6. </p>
  7. # Gooey now supports Python 3!!
  8. Table of Contents
  9. -----------------
  10. - [Gooey](#gooey)
  11. - [Table of contents](#table-of-contents)
  12. - [Latest Update](#latest-update)
  13. - [Quick Start](#quick-start)
  14. - [Installation Instructions](#installation-instructions)
  15. - [Usage](#usage)
  16. - [Examples](#examples)
  17. - [What It Is](#what-is-it)
  18. - [Why Is It](#why)
  19. - [Who is this for](#who-is-this-for)
  20. - [How does it work](#how-does-it-work)
  21. - [Internationalization](#internationalization)
  22. - [Global Configuration](#global-configuration)
  23. - [Layout Customization](#layout-customization)
  24. - [Run Modes](#run-modes)
  25. - [Full/Advanced](#advanced)
  26. - [Basic](#basic)
  27. - [No Config](#no-config)
  28. - [Input Validation](#input-validation)
  29. - [Using Dynamic Values](#using-dynamic-values)
  30. - [Showing Progress](#showing-progress)
  31. - [Customizing Icons](#customizing-icons)
  32. - [Packaging](#packaging)
  33. - [Screenshots](#screenshots)
  34. - [Contributing](#wanna-help)
  35. - [Image Credits](#image-credits)
  36. ----------------
  37. ## Quick Start
  38. ### Installation instructions
  39. The easiest way to install Gooey is via `pip`
  40. pip install Gooey
  41. Alternatively, you can install Gooey by cloning the project to your local directory
  42. git clone https://github.com/chriskiehl/Gooey.git
  43. run `setup.py`
  44. python setup.py install
  45. **NOTE:** Python 2 users must manually install WxPython! Unfortunately, this cannot be done as part of the pip installation and should be manually downloaded from the [wxPython website](http://www.wxpython.org/download.php).
  46. ### Usage
  47. Gooey is attached to your code via a simple decorator on whichever method has your `argparse` declarations (usually `main`).
  48. from gooey import Gooey
  49. @Gooey <--- all it takes! :)
  50. def main():
  51. parser = ArgumentParser(...)
  52. # rest of code
  53. Different styling and functionality can be configured by passing arguments into the decorator.
  54. # options
  55. @Gooey(advanced=Boolean, # toggle whether to show advanced config or not
  56. language=language_string, # Translations configurable via json
  57. show_config=True, # skip config screens all together
  58. target=executable_cmd, # Explicitly set the subprocess executable arguments
  59. program_name='name', # Defaults to script name
  60. program_description, # Defaults to ArgParse Description
  61. default_size=(610, 530), # starting size of the GUI
  62. required_cols=1, # number of columns in the "Required" section
  63. optional_cols=2, # number of columbs in the "Optional" section
  64. dump_build_config=False, # Dump the JSON Gooey uses to configure itself
  65. load_build_config=None, # Loads a JSON Gooey-generated configuration
  66. monospace_display=False) # Uses a mono-spaced font in the output screen
  67. )
  68. def main():
  69. parser = ArgumentParser(...)
  70. # rest of code
  71. See: [How does it Work](#how-does-it-work) section for details on each option.
  72. Gooey will do its best to choose sensible widget defaults to display in the GUI. However, if more fine tuning is desired, you can use the drop-in replacement `GooeyParser` in place of `ArgumentParser`. This lets you control which widget displays in the GUI. See: [GooeyParser](#gooeyparser)
  73. from gooey import Gooey, GooeyParser
  74. @Gooey
  75. def main():
  76. parser = GooeyParser(description="My Cool GUI Program!")
  77. parser.add_argument('Filename', widget="FileChooser")
  78. parser.add_argument('Date', widget="DateChooser")
  79. ...
  80. ### Examples
  81. Gooey downloaded and installed? Great! Wanna see it in action? Head over the the [Examples Repository](https://github.com/chriskiehl/GooeyExamples) to download a few ready-to-go example scripts. They'll give you a quick tour of all Gooey's various layouts, widgets, and features.
  82. [Direct Download](https://github.com/chriskiehl/GooeyExamples/archive/master.zip)
  83. What is it?
  84. -----------
  85. Gooey converts your Console Applications into end-user-friendly GUI applications. It lets you focus on building robust, configurable programs in a familiar way, all without having to worry about how it will be presented to and interacted with by your average user.
  86. Why?
  87. ---
  88. Because as much as we love the command prompt, the rest of the world looks at it like an ugly relic from the early '80s. On top of that, more often than not programs need to do more than just one thing, and that means giving options, which previously meant either building a GUI, or trying to explain how to supply arguments to a Console Application. Gooey was made to (hopefully) solve those problems. It makes programs easy to use, and pretty to look at!
  89. Who is this for?
  90. ----------------
  91. If you're building utilities for yourself, other programmers, or something which produces a result that you want to capture and pipe over to another console application (e.g. *nix philosophy utils), Gooey probably isn't the tool for you. However, if you're building 'run and done,' around-the-office-style scripts, things that shovel bits from point A to point B, or simply something that's targeted at a non-programmer, Gooey is the perfect tool for the job. It lets you build as complex of an application as your heart desires all while getting the GUI side for free.
  92. How does it work?
  93. -----------------
  94. Gooey is attached to your code via a simple decorator on whichever method has your `argparse` declarations.
  95. @Gooey
  96. def my_run_func():
  97. parser = ArgumentParser(...)
  98. # rest of code
  99. At run-time, it parses your Python script for all references to `ArgumentParser`. (The older `optparse` is currently not supported.) These references are then extracted, assigned a `component type` based on the `'action'` they provide, and finally used to assemble the GUI.
  100. #### Mappings:
  101. Gooey does its best to choose sensible defaults based on the options it finds. Currently, `ArgumentParser._actions` are mapped to the following `WX` components.
  102. | Parser Action | Widget | Example |
  103. |:----------------------|-----------|------|
  104. | store | TextCtrl | <img src="https://cloud.githubusercontent.com/assets/1408720/7904380/f54e9f5e-07c5-11e5-86e5-82f011c538cf.png"/>|
  105. | store_const | CheckBox | <img src="https://cloud.githubusercontent.com/assets/1408720/7904367/f538c850-07c5-11e5-8cbe-864badfa54a9.png"/>|
  106. | store_true| CheckBox | <img src="https://cloud.githubusercontent.com/assets/1408720/7904367/f538c850-07c5-11e5-8cbe-864badfa54a9.png"/>|
  107. | store_False | CheckBox| <img src="https://cloud.githubusercontent.com/assets/1408720/7904367/f538c850-07c5-11e5-8cbe-864badfa54a9.png"/> |
  108. | append | TextCtrl | <img src="https://cloud.githubusercontent.com/assets/1408720/7904380/f54e9f5e-07c5-11e5-86e5-82f011c538cf.png"/> |
  109. | count| DropDown &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | <img src="https://cloud.githubusercontent.com/assets/1408720/7904371/f53ccbe4-07c5-11e5-80e5-510e2aa22922.png"/> |
  110. | Mutually Exclusive Group | RadioGroup | <img src="https://cloud.githubusercontent.com/assets/1408720/7904383/f553feb8-07c5-11e5-9d5b-eaa4772075a9.png"/>
  111. |choice &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;| DropDown | <img src="https://cloud.githubusercontent.com/assets/1408720/7904379/f54e4da6-07c5-11e5-9e66-d8e6d7f18ac6.png"/> |
  112. ### GooeyParser
  113. If the above defaults aren't cutting it, you can control the exact widget type by using the drop-in `ArgumentParser` replacement `GooeyParser`. This gives you the additional keyword argument `widget`, to which you can supply the name of the component you want to display. Best part? You don't have to change any of your `argparse` code to use it. Drop it in, and you're good to go.
  114. **Example:**
  115. from argparse import ArgumentParser
  116. ....
  117. def main():
  118. parser = ArgumentParser(description="My Cool Gooey App!")
  119. parser.add_argument('filename', help="name of the file to process")
  120. Given then above, Gooey would select a normal `TextField` as the widget type like this:
  121. <p align="center">
  122. <img src="https://cloud.githubusercontent.com/assets/1408720/7904368/f5393e20-07c5-11e5-88e9-c153fc3ecfaa.PNG">
  123. </p>
  124. However, by dropping in `GooeyParser` and supplying a `widget` name, you can display a much more user friendly `FileChooser`
  125. from gooey import GooeyParser
  126. ....
  127. def main():
  128. parser = GooeyParser(description="My Cool Gooey App!")
  129. parser.add_argument('filename', help="name of the file to process", widget='FileChooser')
  130. <p align="center"><img src="https://cloud.githubusercontent.com/assets/1408720/7904370/f53ae23e-07c5-11e5-8757-c8aa6f3013b5.PNG"></p>
  131. **Custom Widgets:**
  132. | Widget | Example |
  133. |----------------|------------------------------|
  134. | DirChooser/FileChooser/MultiFileChooser | <p align="center"><img src="https://cloud.githubusercontent.com/assets/1408720/7904377/f5483b28-07c5-11e5-9d01-1935635fc22d.gif" width="400"></p> |
  135. | DateChooser &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;| <p align="center"><img src="https://cloud.githubusercontent.com/assets/1408720/7904376/f544756a-07c5-11e5-86d6-862ac146ad35.gif" width="400"></p> |
  136. | PasswordField | <p align="center"><img src="https://user-images.githubusercontent.com/1408720/28953722-eae72cca-788e-11e7-8fa1-9a1ef332a053.png" width="400"></p> |
  137. | Listbox | ![image](https://user-images.githubusercontent.com/1408720/31590191-fadd06f2-b1c0-11e7-9a49-7cbf0c6d33d1.png) |
  138. Internationalization
  139. --------------------
  140. <img src="https://cloud.githubusercontent.com/assets/1408720/7904365/f52e9f1a-07c5-11e5-8f31-36a8fc14ac02.jpg" align="right" />
  141. Gooey is international ready and easily ported to your host language. Languages are controlled via an argument to the `Gooey` decorator.
  142. @Gooey(language='russian')
  143. def main():
  144. ...
  145. All program text is stored externally in `json` files. So adding new langauge support is as easy as pasting a few key/value pairs in the `gooey/languages/` directory.
  146. Thanks to some awesome [contributers](https://github.com/chriskiehl/Gooey/graphs/contributors), Gooey currently comes pre-stocked with the following language sets:
  147. - English
  148. - Dutch
  149. - French
  150. - Portuguese
  151. Want to add another one? Submit a [pull request!](https://github.com/chriskiehl/Gooey/compare)
  152. -------------------------------------------
  153. Global Configuration
  154. --------------------
  155. Just about everything in Gooey's overall look and feel can be customized by passing arguments to the decorator.
  156. | Parameter | Summary |
  157. |-----------|---------|
  158. | encoding | Text encoding to use when displaying characters (default: 'utf-8') |
  159. | use_legacy_titles | Rewrites the default argparse group name from "Positional" to "Required". This is primarily for retaining backward compatibilty with previous versions of Gooey (which had poor support/awareness of groups and did its own naive bucketing of arguments). |
  160. | advanced | Toggles whether to show the 'full' configuration screen, or a simplified version |
  161. | auto_start | Skips the configuration all together and runs the program immediately |
  162. | language | Tells Gooey which language set to load from the `gooey/languages` directory.|
  163. | target | Tells Gooey how to re-invoke itself. By default Gooey will find python, but this allows you to specify the program (and arguments if supplied).|
  164. |program_name | The name displayed in the title bar of the GUI window. If not supplied, the title defaults to the script name pulled from `sys.argv[0]`. |
  165. | program_description | Sets the text displayed in the top panel of the `Settings` screen. Defaults to the description pulled from `ArgumentParser`. |
  166. | default_size | Initial size of the window |
  167. | required_cols | Controls how many columns are in the Required Arguments section <br> :warning: **Deprecation notice:** See [Group Parameters](#group-configuration) for modern layout controls|
  168. | optional_cols | Controls how many columns are in the Optional Arguments section <br> :warning: **Deprecation notice:** See [Group Parameters](#group-configuration) for modern layout controls|
  169. | dump_build_config | Saves a `json` copy of its build configuration on disk for reuse/editing |
  170. | load_build_config | Loads a `json` copy of its build configuration from disk |
  171. | monospace_display | Uses a mono-spaced font in the output screen <br> :warning: **Deprecation notice:** See [Group Parameters](#group-configuration) for modern font configuration|
  172. | image_dir | Path to the directory in which Gooey should look for custom images/icons |
  173. | language_dir | Path to the directory in which Gooey should look for custom languages files |
  174. | disable_stop_button | Disable the `Stop` button when running |
  175. | show_stop_warning | Displays a warning modal before allowing the user to force termination of your program |
  176. | force_stop_is_error | Toggles whether an early termination by the shows the success or error screen |
  177. | show_success_modal | Toggles whether or not to show a summary modal after a successful run |
  178. | run_validators | Controls whether or not to have Gooey perform validation before calling your program |
  179. | poll_external_updates | (Experimental!) When True, Gooey will call your code with a `gooey-seed-ui` CLI argument and use the response to fill out dynamic values in the UI (See: [Using Dynamic Values](#using-dynamic-values))|
  180. | return_to_config | When True, Gooey will return to the configuration settings window upon successful run |
  181. | progress_regex | A text regex used to pattern match runtime progress information. See: [Showing Progress](#showing-progress) for a detailed how-to |
  182. | progress_expr | A python expression applied to any matches found via the `progress_regex`. See: [Showing Progress](#showing-progress) for a detailed how-to |
  183. | disable_progress_bar_animation | Disable the progress bar |
  184. | navigation | Sets the "navigation" style of Gooey's top level window. <br>Options: <table> <thead> <tr><th>TABBED</th><th>SIDEBAR</th></tr></thead> <tbody> <tr> <td><img src="https://user-images.githubusercontent.com/1408720/34464826-2a946ba2-ee47-11e7-92a4-4afeb49dc9ca.png" width="200" height="auto"></td><td><img src="https://user-images.githubusercontent.com/1408720/34464847-9918fbb0-ee47-11e7-8d5f-0d42631c2bc0.png" width="200" height="auto"></td></tr></tbody></table>|
  185. | sidebar_title | <img src="https://user-images.githubusercontent.com/1408720/34472159-1bfedbd0-ef10-11e7-8bc3-b6d69febb8c3.png" width="250" height="auto" align="right"> Controls the heading title above the SideBar's navigation pane. Defaults to: "Actions" |
  186. | show_sidebar | Show/Hide the sidebar in when navigation mode == `SIDEBAR` |
  187. | body_bg_color | HEX value of the main Gooey window |
  188. | header_bg_color | HEX value of the header background |
  189. | header_height | height in pixels of the header |
  190. | header_show_title | Show/Hide the header title |
  191. | header_show_subtitle | Show/Hide the header subtitle |
  192. | footer_bg_color | HEX value of the Footer background |
  193. | sidebar_bg_color | HEX value of the Sidebar's background |
  194. | terminal_panel_color | HEX value of the terminal's panel |
  195. | terminal_font_color | HEX value of the font displayed in Gooey's terminal |
  196. | terminal_font_family | Name of the Font Family to use in the terminal |
  197. | terminal_font_weight | Weight of the font (NORMAL|BOLD) |
  198. | terminal_font_size | Point size of the font displayed in the terminal |
  199. | error_color | HEX value of the text displayed when a validation error occurs |
  200. Layout Customization
  201. --------------------
  202. You can achieve fairly flexible layouts with Gooey by using a few simple customizations.
  203. At the highest level, you have several overall layout options controllable via various arguments to the Gooey decorator.
  204. | `show_sidebar=True` | `show_sidebar=False` | `navigation='TABBED'` | `tabbed_groups=True` |
  205. |---------------------|----------------------|----------------------|------------------------|
  206. |<img src="https://user-images.githubusercontent.com/1408720/34464847-9918fbb0-ee47-11e7-8d5f-0d42631c2bc0.png" width="400"> |<img src="https://user-images.githubusercontent.com/1408720/35487799-762aa308-0434-11e8-8eb3-1e9fab2d13ae.png" width="400"> |<img src="https://user-images.githubusercontent.com/1408720/34464835-5ba9b0e4-ee47-11e7-9561-55e3647c2165.png" width="400"> |<img src="https://user-images.githubusercontent.com/1408720/34464826-2a946ba2-ee47-11e7-92a4-4afeb49dc9ca.png" width="400"> |
  207. **Grouping Inputs**
  208. By default, if you're using Argparse with Gooey, your inputs will be split into two buckets: `positional` and `optional`. However, these aren't always the most descriptive groups to present to your user. You can arbitrarily bucket inputs into logic groups and customize the layout of each.
  209. With `argparse` this is done via `add_argument_group()`
  210. <img src="https://user-images.githubusercontent.com/1408720/35487956-a4c9915e-0436-11e8-8a11-fd21528aedf0.png" align="right" width="410">
  211. ```
  212. parser = ArgumentParser()
  213. search_group = parser.add_argument_group(
  214. "Search Options",
  215. "Customize the search options"
  216. )
  217. ```
  218. You can add arguments to the group as normal
  219. ```
  220. search_group.add_argument(
  221. '--query',
  222. help='Base search string'
  223. )
  224. ```
  225. Which will display them as part of the group within the UI.
  226. **Customizing Group Layout**
  227. > Note: Make sure you're using GooeyParser if you want to take advantage of the layout customizations!
  228. With a group created, we can now start tweaking how it looks! `GooeyParser` extends the API of `add_argument_group` to accept an additional keyword argument: `gooey_options`. It accepts two keys: `show_border` and `columns`
  229. ```
  230. gooey_options={
  231. 'show_border': Bool,
  232. 'columns': 1-100
  233. }
  234. ```
  235. <img src="https://user-images.githubusercontent.com/1408720/35488154-e201ab90-0438-11e8-9479-3a27fd1c523e.png" align="right" width="400">
  236. `show_border` is nice for visually tying together closely related items within a parent group. Setting it to `true` will draw a small border around all of the inputs and nest the title at the top.
  237. `columns` controls how many many items get places on each row within the
  238. Run Modes
  239. ---------
  240. Gooey has a handful of presentation modes so you can tailor its layout to your content type and user's level or experience.
  241. ### Advanced
  242. The default view is the "full" or "advanced" configuration screen. It has two different layouts depending on the type of command line interface it's wrapping. For most applications, the flat layout will be the one to go with, as its layout matches best to the familiar CLI schema of a primary command followed by many options (e.g. Curl, FFMPEG).
  243. On the other side is the Column Layout. This one is best suited for CLIs that have multiple paths or are made up of multiple little tools each with their own arguments and options (think: git). It displays the primary paths along the left column, and their corresponding arguments in the right. This is a great way to package a lot of varied functionality into a single app.
  244. <p align="center">
  245. <img src="https://cloud.githubusercontent.com/assets/1408720/7927433/f06a36cc-08ad-11e5-843e-9322df96d4d6.png">
  246. </p>
  247. Both views present each action in the `Argument Parser` as a unique GUI component. It makes it ideal for presenting the program to users which are unfamiliar with command line options and/or Console Programs in general. Help messages are displayed along side each component to make it as clear as possible which each widget does.
  248. **Setting the layout style:**
  249. Currently, the layouts can't be explicitely specified via a parameter (on the TODO!). The layouts are built depending on whether or not there are `subparsers` used in your code base. So, if you want to trigger the `Column Layout`, you'll need to add a `subparser` to your `argparse` code.
  250. It can be toggled via the `advanced` parameter in the `Gooey` decorator.
  251. @gooey(advanced=True)
  252. def main():
  253. # rest of code
  254. --------------------------------------------
  255. ### Basic
  256. The basic view is best for times when the user is familiar with Console Applications, but you still want to present something a little more polished than a simple terminal. The basic display is accessed by setting the `advanced` parameter in the `gooey` decorator to `False`.
  257. @gooey(advanced=False)
  258. def main():
  259. # rest of code
  260. <p align="center">
  261. <img src="https://cloud.githubusercontent.com/assets/1408720/7904369/f53a4306-07c5-11e5-8e63-b510d6db9953.png">
  262. </p>
  263. ----------------------------------------------
  264. ### No Config
  265. No Config pretty much does what you'd expect: it doesn't show a configuration screen. It hops right to the `display` section and begins execution of the host program. This is the one for improving the appearance of little one-off scripts.
  266. <p align="center">
  267. <img src="https://cloud.githubusercontent.com/assets/1408720/7904382/f54fe6f2-07c5-11e5-92e4-f72a2ae12862.png">
  268. </p>
  269. ---------------------------------------
  270. ### Input Validation
  271. <img src="https://user-images.githubusercontent.com/1408720/34464861-0e82c214-ee48-11e7-8f4a-a8e00721efef.png" width="400" height="auto" align="right" />
  272. >:warning:
  273. >Note! This functionality is experimental. Its API may be changed or removed alltogether. Feedback/thoughts on this feature is welcome and encouraged!
  274. Gooey can optionally do some basic pre-flight validation on user input. Internally, it uses these validator functions to check for the presence of required arguments. However, by using [GooeyParser](#gooeyparser), you can extend these functions with your own validation rules. This allows Gooey to show much, much more user friendly feedback before it hands control off to your program.
  275. **Writing a validator:**
  276. Validators are specified as part of the `gooey_options` map available to `GooeyParser`. It's a simple map structure made up of a root key named `validator` and two internal pairs:
  277. * `test` The inner body of the validation test you wish to perform
  278. * `message` the error message that should display given a validation failure
  279. e.g.
  280. ```
  281. gooey_options={
  282. 'validator':{
  283. 'test': 'len(user_input) > 3',
  284. 'message': 'some helpful message'
  285. }
  286. }
  287. ```
  288. **The `test` function**
  289. Your test function can be made up of any valid Python expression. It receives the variable `user_input` as an argument against which to perform its validation. Note that all values coming from Gooey are in the form of a string, so you'll have to cast as needed in order to perform your validation.
  290. **Full Code Example**
  291. ```
  292. from gooey.python_bindings.gooey_decorator import Gooey
  293. from gooey.python_bindings.gooey_parser import GooeyParser
  294. @Gooey
  295. def main():
  296. parser = GooeyParser(description='Example validator')
  297. parser.add_argument(
  298. 'secret',
  299. metavar='Super Secret Number',
  300. help='A number specifically between 2 and 14',
  301. gooey_options={
  302. 'validator': {
  303. 'test': '2 <= int(user_input) <= 14',
  304. 'message': 'Must be between 2 and 14'
  305. }
  306. })
  307. args = parser.parse_args()
  308. print("Cool! Your secret number is: ", args.secret)
  309. ```
  310. <img src="https://user-images.githubusercontent.com/1408720/34465024-f011ac3e-ee4f-11e7-80ae-330adb4c47d6.png" width="400" height="auto" align="left" />
  311. With the validator in place, Gooey can present the error messages next to the relevant input field if any validators fail.
  312. ---------------------------------------
  313. ## Using Dynamic Values
  314. >:warning:
  315. >Note! This functionality is experimental. Its API may be changed or removed alltogether. Feedback on this feature is welcome and encouraged!
  316. Gooey's Choice style fields (Dropdown, Listbox) can be fed a dynamic set of values at runtime by enabling the `poll_external_updates` option. This will cause Gooey to request updated values from your program everytime the user visits the Configuration page. This can be used to, for instance, show the result of a previous execution on the config screen without requiring that the user restart the program.
  317. **How does it work?**
  318. <img src="https://user-images.githubusercontent.com/1408720/35487459-bd7fe938-0430-11e8-9f6d-fa8f703b9da5.gif" align="right" width="420"/>
  319. At runtime, whenever the user hits the Configuration screen, Gooey will call your program with a single CLI argument: `gooey-seed-ui`. This is a request to your program for updated values for the UI. In response to this, on `stdout`, your program should return a JSON string mapping cli-inputs to a list of options.
  320. For example, assuming a setup where you have a dropdown that lists user files:
  321. ```
  322. ...
  323. parser.add_argument(
  324. '--load',
  325. metavar='Load Previous Save',
  326. help='Load a Previous save file',
  327. dest='filename',
  328. widget='Dropdown',
  329. choices=list_savefiles(),
  330. )
  331. ```
  332. Here the input we want to populate is `--load`. So, in response to the `gooey-seed-ui` request, you would return a JSON string with `--load` as the key, and a list of strings that you'd like to display to the user as the value. e.g.
  333. ```
  334. {"--load": ["Filename_1.txt", "filename_2.txt", ..., "filename_n.txt]}
  335. ```
  336. Checkout the full example code in the [Examples Repository](https://github.com/chriskiehl/GooeyExamples/blob/master/examples/dynamic_updates.py). Or checkout a larger example in the silly little tool that spawned this feature: [SavingOverIt](https://github.com/chriskiehl/SavingOverIt).
  337. -------------------------------------
  338. ## Showing Progress
  339. <img src="https://user-images.githubusercontent.com/1408720/45590349-55bbda80-b8eb-11e8-9aed-b4fe377756ac.png" align="right" width="420"/>
  340. Giving visual progress feedback with Gooey is easy! If you're already displaying textual progress updates, you can tell Gooey to hook into that existing output in order to power its Progress Bar.
  341. For simple cases, output strings which resolve to a numeric representation of the completion percentage (e.g. `Progress 83%`) can be pattern matched and turned into a progress bar status with a simple regular expression (e.g. `@Gooey(progress_regex=r"^progress: (\d+)%$")`).
  342. For more complicated outputs, you can pass in a custom evaluation expression (`progress_expr`) to transform the things however you need.
  343. **Program Output:**
  344. ```
  345. progress: 1/100
  346. progress: 2/100
  347. progress: 3/100
  348. ...
  349. ```
  350. **Regex and Processing Expression**
  351. ```python
  352. @Gooey(progress_regex=r"^progress: (?P<current>\d+)/(?P<total>\d+)$",
  353. progress_expr="current / total * 100")
  354. ```
  355. There are lots of options for telling Gooey about progress as your program is running. Checkout the [Gooey Examples](https://github.com/chriskiehl/GooeyExamples) repository for more detailed usage and examples!
  356. | progress_regex | A text regex used to pattern match runtime progress information. See: [Showing Progress](#showing-progress) for a detailed how-to |
  357. | progress_expr | A python expression applied to any matches found via the `progress_regex`. See: [Showing Progress](#showing-progress) for a detailed how-to |
  358. --------------------------------------
  359. ## Customizing Icons
  360. Gooey comes with a set of six default icons. These can be overridden with your own custom images/icons by telling Gooey to search additional directories when initializing. This is done via the `image_dir` argument to the `Goeey` decorator.
  361. @Gooey(program_name='Custom icon demo', image_dir='/path/to/my/image/directory')
  362. def main():
  363. # rest of program
  364. Images are discovered by Gooey based on their _filenames_. So, for example, in order to supply a custom configuration icon, simply place an image with the filename `config_icon.png` in your images directory. These are the filenames which can be overridden:
  365. * program_icon.ico
  366. * success_icon.png
  367. * running_icon.png
  368. * loading_icon.gif
  369. * config_icon.png
  370. * error_icon.png
  371. ## Packaging
  372. Thanks to some [awesome contributers](https://github.com/chriskiehl/Gooey/issues/58), packaging Gooey as an executable is super easy.
  373. The tl;dr [pyinstaller](https://github.com/pyinstaller/pyinstaller) version is to drop this [build.spec](https://github.com/chriskiehl/Gooey/files/29568/build.spec.txt) into the root directory of your application. Edit its contents so that the `application` and `name` are relevant to your project, then execute `pyinstaller build.spec` to bundle your app into a ready-to-go executable.
  374. Detailed step by step instructions can be found [here](http://chriskiehl.com/article/packaging-gooey-with-pyinstaller/).
  375. Screenshots
  376. ------------
  377. | Flat Layout | Column Layout |Success Screen | Error Screen | Warning Dialog |
  378. |-------------|---------------|---------------|--------------|----------------|
  379. | <img src="https://cloud.githubusercontent.com/assets/1408720/7950190/4414e54e-0965-11e5-964b-f717a7adaac6.jpg"> | <img src="https://cloud.githubusercontent.com/assets/1408720/7950189/4411b824-0965-11e5-905a-3a2b5df0efb3.jpg"> | <img src="https://cloud.githubusercontent.com/assets/1408720/7950192/44165442-0965-11e5-8edf-b8305353285f.jpg"> | <img src="https://cloud.githubusercontent.com/assets/1408720/7950188/4410dcce-0965-11e5-8243-c1d832c05887.jpg"> | <img src="https://cloud.githubusercontent.com/assets/1408720/7950191/4415432c-0965-11e5-9190-17f55460faf3.jpg"> |
  380. | Custom Groups | Tabbed Groups | Tabbed Navigation | Sidebar Navigation | Input Validation |
  381. |-------------|---------------|---------------|--------------|----------------|
  382. | <img src="https://user-images.githubusercontent.com/1408720/34464824-c044d57a-ee46-11e7-9c35-6e701a7c579a.png"> | <img src="https://user-images.githubusercontent.com/1408720/34464826-2a946ba2-ee47-11e7-92a4-4afeb49dc9ca.png"> | <img src="https://user-images.githubusercontent.com/1408720/34464835-5ba9b0e4-ee47-11e7-9561-55e3647c2165.png"> | <img src="https://user-images.githubusercontent.com/1408720/34464847-9918fbb0-ee47-11e7-8d5f-0d42631c2bc0.png"> | <img src="https://user-images.githubusercontent.com/1408720/34464861-0e82c214-ee48-11e7-8f4a-a8e00721efef.png"> |
  383. ----------------------------------------------
  384. Wanna help?
  385. -----------
  386. Code, translation, graphics? Pull requests are welcome.
  387. [1]: http://i.imgur.com/7fKUvw9.png