Use this module to convert a CLI program to a GUI
- Comparison to similar projects
- Roadmap
- Decorator
- Using the decorator in your project
- Click
- Data Structures
- Documentation
- Install With PIP
- Language information
- Install Python on Windows
- Install Python on Linux
- Install Python on MacOS
- How to run
- Download Project
- Screenshots
- Community Files
Do let me know if any of these are incorrect. Some of the comparisons are based off documentation/ the readme
Parser | Cli2Gui | Gooey | Quick |
---|---|---|---|
Argparse | ✔️ | ✔️ | ❌ |
Optparse | ✔️ | ❌ | ❌ |
DocOpt | ✔️ | ❌ | ❌ |
Click | ✔️ * | ❌ | ✔️ |
GetOpt | ✔️ | ❌ | ❌ |
Dephell Argparse | ✔️ | ❌ | ❌ |
* Partial support (use Click2Gui)
This works for simpler programs but sadly falls flat for more complex programs
GUI Toolkits | Cli2Gui | Gooey | Quick |
---|---|---|---|
Tkinter | ✔️ | ❌ | ❌ |
WxWidgets | ❌ | ✔️ | ❌ |
Qt | ✔️ | ❌ | ✔️ |
Gtk | ❌ | ❌ | ❌ |
Web | ✔️ | ❌ | ❌ |
Basic GUI | Cli2Gui | Gooey | Quick |
---|---|---|---|
Override name/ description | ✔️ | ✔️ | ❌ |
Theming | ✔️ | ||
DarkMode | ✔️ | ❌ | ✔️ |
Window Size | ✔️ | ✔️ | ❌ |
Element Size | ✔️ | ❌ | ❌ |
Custom Images | ✔️ | ✔️ | ❌ |
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 | ✔️ | ✔️ | ✔️ |
Slider | ❌ | ✔️ | ✔️ |
Tabs | ❌ | ✔️ | ✔️ |
Menus | ✔️ | ✔️ | ❌ |
Max Args before Scroll | ✔️ | ❌ | ❌ |
For completed components, see the changelog (link below)
Feature | Description | Status |
---|---|---|
Python Fire | https://github.com/google/python-fire | Under consideration |
@Cli2Gui(run_function, auto_enable=False, parser="argparse", gui="pysimplegui",
theme="", darkTheme="", sizes="", image="", program_name="",
program_description="", max_args_shown=5, **kwargs)
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)
Enable the GUI by default. If enabled by default requires --disable-cli2gui
, otherwise requires --cli2gui
@Cli2Gui(auto_enable=False)
Override the parser to use, defaults to argparse. Current options are: "argparse", "getopt", "optparse", "docopt", "dephell_argparse"
@Cli2Gui(parser="argparse")
Override the gui to use. Current options are: "pysimplegui", "pysimpleguiqt","pysimpleguiweb". Defaults to "pysimplegui".
pysimplegui is the recommended option
@Cli2Gui(gui="pysimplegui")
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"])
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"])
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})
Set the program icon. File extensions can be any that PIL supports
@Cli2Gui(image="path/to/image.png")
Override the program name
@Cli2Gui(program_name="custom name")
Override the program description
@Cli2Gui(program_description="this is a custom description")
Maximum number of args shown before using a scrollbar
@Cli2Gui(max_args_shown=5)
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", })
def Click2Gui(run_function, gui="pysimplegui", theme="", darkTheme="",
sizes="", image="", program_name="", program_description="",
max_args_shown=5, menu="", **kwargs):
Very similar to the decorator but with the following differences...
Specify the click function to use. (attempts were made to offer full program support however this behaved very poorly)
As this is exclusively for click, this option is not present
See the DATA_STRUCTURES for more information.
See the Docs for more information.
pip install cli2gui
Head to https://pypi.org/project/cli2gui/ for more info
This program has been written for Python versions 3.7 - 3.10 and has been tested with both 3.7 and 3.10
choco install python
To install Python, go to https://www.python.org/downloads/windows/ and download the latest version.
sudo apt install python3.x
sudo dnf install python3.x
brew install [email protected]
To install Python, go to https://www.python.org/downloads/macos/ and download the latest version.
-
Module
py -3.x -m [module]
or[module]
(if module installs a script) -
File
py -3.x [file]
or./[file]
-
Module
python3.x -m [module]
or[module]
(if module installs a script) -
File
python3.x [file]
or./[file]
-
Press the Clone or download button in the top right
-
Copy the URL (link)
-
Open the command line and change directory to where you wish to clone to
-
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
- Press the Clone or download button in the top right
- Click open in desktop
- 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 this GitHub repository
- Extract the zip archive
- Copy/ move to the desired location
Light | Dark | Black |
---|---|---|
![]() |
![]() |
![]() |
MIT License Copyright (c) FredHappyface (See the LICENSE for more information.)
See the Changelog for more information.
Online communities include people from many backgrounds. The Project contributors are committed to providing a friendly, safe and welcoming environment for all. Please see the Code of Conduct for more information.
Contributions are welcome, please see the Contributing Guidelines for more information.
Thank you for improving the security of the project, please see the Security Policy for more information.
Thank you for using this project, I hope it is of use to you. Please be aware that those involved with the project often do so for fun along with other commitments (such as work, family, etc). Please see the Support Policy for more information.
The rationale acts as a guide to various processes regarding projects such as the versioning scheme and the programming styles used. Please see the Rationale for more information.