cli2gui 2020.8

Use this module to convert a cli program to a gui

Cli2Gui

Use this module to convert a CLI program to a GUI

• Comparison to similar projects
  • Parser Support
  • GUI Toolkit Support
  • GUI Feature Support
• Roadmap
• Changelog
• Decorator
• Using the decorator in your project
  • run_function (optional)
  • auto_enable (optional)
  • parser (optional)
  • gui (optional)
  • theme (optional)
  • darkTheme (optional)
  • sizes (optional)
  • image (optional)
  • program_name (optional)
  • program_description (optional)
  • max_args_shown (optional)
  • menu (optional)
• Click
  • run_function (required)
  • parser (not applicable)
• Data Structures
• Install With PIP
• Language information
  • Built for
• Install Python on Windows
  • Chocolatey
  • Download
• Install Python on Linux
  • Apt
• How to run
  • With VSCode
  • From the Terminal
• How to update, build and publish
• Download
  • Clone
    • Using The Command Line
    • Using GitHub Desktop
  • Download Zip File
• Licence
• Screenshots
  • Desktop
  • Themes

Comparison to similar projects

Do let me know if any of these are incorrect. Some of the comparisons are based off documentation/ the readme

Parser Support

Parser	Cli2Gui	Gooey	Quick
Argparse	:heavy_check_mark:	:heavy_check_mark:	:x:
Optparse	:heavy_check_mark:	:x:	:x:
DocOpt	:heavy_check_mark:	:x:	:x:
Click	:heavy_check_mark: *	:x:	:heavy_check_mark:
GetOpt	:heavy_check_mark:	:x:	:x:
Dephell Argparse	:heavy_check_mark:	:x:	:x:

* Partial support (use Click2Gui)

This works for simpler programs but sadly falls flat for more complex programs

GUI Toolkit Support

GUI Toolkits	Cli2Gui	Gooey	Quick
Tkinter	:heavy_check_mark:	:x:	:x:
WxWidgets	:x:	:heavy_check_mark:	:x:
Qt	:heavy_check_mark:	:x:	:heavy_check_mark:
Gtk	:x:	:x:	:x:
Web	:heavy_check_mark:	:x:	:x:

GUI Feature Support

Basic GUI	Cli2Gui	Gooey	Quick
Override name/ description	:heavy_check_mark:	:heavy_check_mark:	:x:
Theming	:heavy_check_mark:	:warning: Limited	:warning: Limited
DarkMode	:heavy_check_mark:	:x:	:heavy_check_mark:
Window Size	:heavy_check_mark:	:heavy_check_mark:	:x:
Element Size	:heavy_check_mark:	:x:	:x:
Custom Images	:heavy_check_mark:	:heavy_check_mark:	:x:

Cli2Gui is pretty lacking in these features and will probably remain that way to ease maintainability - the primary aim is to support multiple argparse libraries over fancy widgets

Advanced GUI	Cli2Gui	Gooey	Quick
Dropdown	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
Slider	:x:	:heavy_check_mark:	:heavy_check_mark:
Tabs	:x:	:heavy_check_mark:	:heavy_check_mark:
Menus	:heavy_check_mark:	:heavy_check_mark:	:x:
Max Args before Scroll	:heavy_check_mark:	:x:	:x:

Roadmap

For completed components, see the changelog (link below)

Feature	Description	Status
Python Fire	https://github.com/google/python-fire	Under consideration

Changelog

See the CHANGELOG for more information.

Decorator

@Cli2Gui(run_function, auto_enable=False, parser="argparse", gui="pysimplegui",
		theme=None, darkTheme=None, sizes=None, image=None, program_name=None,
		program_description=None, max_args_shown=5, **kwargs)

Using the decorator in your project

run_function (optional)

The name of the function to call eg. main(args). Defaults to None. If not specified, program continues as normal (can only run once)

def main(args):
	print(args.arg)

@Cli2Gui(run_function=main)
def cli():
	parser = argparse.ArgumentParser(description="this is an example parser")
	parser.add_argument("arg", type=str,
		help="positional arg")
	args = parser.parse_args()
	main(args)

auto_enable (optional)

Enable the GUI by default. If enabled by default requires --disable-cli2gui, otherwise requires --cli2gui

@Cli2Gui(auto_enable=False)

parser (optional)

Override the parser to use, defaults to argparse. Current options are: "argparse", "getopt", "optparse", "docopt", "dephell_argparse"

@Cli2Gui(parser="argparse")

gui (optional)

Override the gui to use. Current options are: "pysimplegui", "pysimpleguiqt","pysimpleguiweb". Defaults to "pysimplegui".

pysimplegui is the recommended option

@Cli2Gui(gui="pysimplegui")

theme (optional)

Set a base24 theme. Can also pass a base24 scheme file. eg. one-light.yaml

@Cli2Gui(theme=["#e7e7e9", "#dfdfe1", "#cacace", "#a0a1a7", "#696c77",
		"#383a42", "#202227", "#090a0b", "#ca1243", "#c18401", "#febb2a",
		"#50a14f", "#0184bc", "#4078f2", "#a626a4", "#986801", "#f0f0f1",
		"#fafafa", "#ec2258", "#f4a701", "#6db76c", "#01a7ef", "#709af5",
		"#d02fcd"])

darkTheme (optional)

Set a base24 dark theme variant. Can also pass a base24 scheme file. eg. one-dark.yaml

@Cli2Gui(darkTheme=["#282c34", "#3f4451", "#4f5666", "#545862", "#9196a1",
		"#abb2bf", "#e6e6e6", "#ffffff", "#e06c75", "#d19a66", "#e5c07b",
		"#98c379", "#56b6c2", "#61afef", "#c678dd", "#be5046", "#21252b",
		"#181a1f", "#ff7b86", "#efb074", "#b1e18b", "#63d4e0", "#67cdff",
		"#e48bff"])

sizes (optional)

Set the UI sizes such as the button size

@Cli2Gui(sizes={
		"title_size": 28,
		"label_size": (30, None),
		"input_size": (30, 1),
		"button":(10, 1),
		"padding":(5, 10),
		"helpText_size": 14,
		"text_size": 11})

image (optional)

Set the program icon. File extensions can be any that PIL supports

@Cli2Gui(image="path/to/image.png")

program_name (optional)

Override the program name

@Cli2Gui(program_name="custom name")

program_description (optional)

Override the program description

@Cli2Gui(program_description="this is a custom description")

max_args_shown (optional)

Maximum number of args shown before using a scrollbar

@Cli2Gui(max_args_shown=5)

menu (optional)

Add a menu to the program. Defaults to None. eg.

THIS_DIR = str(Path(__file__).resolve().parent)
menu={"File": THIS_DIR + "/file.md"}

Works significantly better with pysimplegui than pysimpleguiqt

@Cli2Gui(menu={"File": THIS_DIR + "/file.md", "Another File": THIS_DIR + "/another_file.md", })

Click

def Click2Gui(run_function, gui="pysimplegui", theme=None, darkTheme=None,
		sizes=None, image=None, program_name=None, program_description=None,
		max_args_shown=5, menu=None, **kwargs):

Very similar to the decorator but with the following differences...

run_function (required)

Specify the click function to use. (attempts were made to offer full program support however this behaved very poorly)

parser (not applicable)

As this is exclusively for click, this option is not present

Data Structures

See the DATA_STRUCTURES for more information.

Install With PIP

pip install cli2gui

Head to https://pypi.org/project/cli2gui/ for more info

Language information

Built for

This program has been written for Python 3 and has been tested with Python version 3.8.0 https://www.python.org/downloads/release/python-380/.

Install Python on Windows

Chocolatey

choco install python

Download

To install Python, go to https://www.python.org/ and download the latest version.

Install Python on Linux

Apt

sudo apt install python3.8

How to run

With VSCode

1. Open the .py file in vscode
2. Ensure a python 3.8 interpreter is selected (Ctrl+Shift+P > Python:Select Interpreter > Python 3.8)
3. Run by pressing Ctrl+F5 (if you are prompted to install any modules, accept)

From the Terminal

./[file].py

How to update, build and publish

1. Ensure you have installed the following dependencies Linux

   wget dephell.org/install | python3.8
   wget https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python3.8
   

   Windows

   (wget dephell.org/install -UseBasicParsing).Content | python
   (wget https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python
   

2. Use poetry for the heavy lifting and dephell to generate requirements

   poetry update
   dephell deps convert
   

3. Build/ Publish

   poetry build
   poetry publish
   

   or

   poetry publish --build
   

Download

Clone

Using The Command Line

1. Press the Clone or download button in the top right
2. Copy the URL (link)
3. Open the command line and change directory to where you wish to clone to
4. Type 'git clone' followed by URL in step 2

$ git clone https://github.com/FHPythonUtils/Cli2Gui

More information can be found at https://help.github.com/en/articles/cloning-a-repository

Using GitHub Desktop

1. Press the Clone or download button in the top right
2. Click open in desktop
3. Choose the path for where you want and click Clone

More information can be found at https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop

Download Zip File

1. Download this GitHub repository
2. Extract the zip archive
3. Copy/ move to the desired location

Licence

MIT License (See the LICENSE for more information.)

Screenshots

Desktop

Themes

Light	Dark	Black