clooey

Command Line Interface (CLI) to a minimal Web UI.

Getting Started

Start by installing clooey using pip.

pip install clooey

You can then use the API to convert a script into a form.

import clooey

cli = clooey.parse('sample.py')
html = clooey.generate(cli, clooey.TEMPLATE_FORM)

Want to customize the form HTML? All templates are Jinja2 formatted. By default, the form template is provided with one inputs list of strings, which are the prompts provided to input function calls.

Web Demo

See an actual web form by running the following command:

clooey web

From left to right, you'll see the launched Flask app with the following form, fill out the form as you would the CLI, then submit the form to see the output.

You can optionally provide your own script to parse. For example,

wget https://github.com/alvinwan/clooey/blob/main/clooey/examples/password.py
clooey web --program password.py

CLI Demo

Run the CLI.

clooey cli

You'll then see the following output

<form method="post">
    
    <label>Enter your name: </label>
    <input type="text" name="1">
    
    <label>Enter your age: </label>
    <input type="text" name="2">
    
    <label>Enter your city: </label>
    <input type="text" name="3">
    
    <input type="submit" value="submit">
</form>

Next, the script will prompt you for input, as though you were filling out the web form.

Enter your name: Alvin
Enter your age: 1000
Enter your city: Seattle

Finally, the script will execute the Python script with the input values.

Welcome to Seattle, Alvin (1000)!

You can optionally provide your own script to parse. For example,

wget https://github.com/alvinwan/clooey/blob/main/clooey/examples/piglatin.py
clooey cli --program piglatin.py