Version
Web	http://quo.readthedocs.io/
Download
Source	http://github.com/secretum-inc/quo

Forever Scalable

Quo is a Python based toolkit for writing Command-Line Interface(CLI) applications. Quo is making headway towards composing speedy and orderly CLI applications while forestalling any disappointments brought about by the failure to execute a CLI API. Simple to code, easy to learn, and does not come with needless baggage.

Quo requires Python 3.8 or later.

• [x] Support for Ansi, RGB and HTML color models

• [x] Support for tabular presentation of data

• [x] Interactive progressbars

• [x] Code completions

• [x] Nesting of commands

• [x] Automatic help page generation

• [x] Syntax highlighting

• [x] Autosuggestions

• [x] Key Binders

Quo is…

Simple If you know Python you can easily use Quo and it can integrate with just about anything.

Tutorials & Explanations

• Introduction
  • Requirements
  • Installation
  • Quick Start
• Printing (and using) formatted text
  • echo
  • print
  • Formatted text
    • [1] Using quo.echo
    • [2] Using quo.text.Text
    • (style, text) tuples
    • Pygments ``(Token, text) tuples``
• Console API
  • Attributes
  • Launching Editors
  • File Opening
  • Launching Applications
  • Terminal size
  • Encoding
  • Rules
  • A simple console application
• Prompts
  • App Prompts
  • Input Validation
    • Number Validator
  • Input Prompts using Prompt() class
  • Multiline Input
  • Hide Input
    • Using function quo.prompt()
    • Using class `quo.prompt.Prompt()
  • Confirmation Prompts
  • System prompt
  • Suspend prompt
  • Prompt bottom toolbar
  • Right prompt(rprompt)
  • Syntax highlighting
  • Placeholder text
    • Plain text placeholder
    • Formatted text placeholder
  • Colors
    • Coloring the prompt itself
  • Completion
    • Auto suggestion
    • Autocompletion
    • Nested completion
    • Complete while typing
  • History
    • InMemoryHistory
    • FileHistory
  • Adding custom key bindings
    • Enable key bindings according to a condition
    • Toggle visibility of input
    • Using control-space for completion
  • Other Prompt options
    • Multiline input
    • Mouse support
    • Line wrapping
• Utilities
  • Printing to Stdout
  • Printing to Standard error
  • American National Standards Institute(ANSI) Colors
  • Scrollable test
  • Screen Clearing
  • Getting Characters from Terminal(getchar)
  • Waiting for Key Press(pause)
  • Printing Filenames
  • Standard Streams
  • Finding Application Folders
• Table
  • Printing tabular data
• Commands and Tethers
  • Callback Invocation
  • Passing Parameters
  • Nested Handling and Climes
  • Decorating Commands
  • Tether Invocation Without Command
  • Merging Multi Commands
  • Multi Command Chaining
  • Multi Command Pipelines
  • Overriding Defaults
  • Clime Defaults
  • Command Return Values
• Apps
  • How to name Apps
  • Basic Value Apps
  • Multi Value Apps
  • Tuples as Multi Value Apps
  • Multiple Apps
  • Counting
  • Boolean Flags
  • Feature Switches
  • Choice Apps
  • Prompting
  • Password Prompts
  • Dynamic Defaults for Prompts
  • Callbacks and Eager Apps
  • Yes Parameters
  • Values from Environment Variables
  • Multiple Values from Environment Values
  • Other Prefix Characters
  • Range Apps
  • Callbacks for Validation
  • Optional Value
• Args
  • Basic Args
  • Variadic Args
  • File Arguments
  • File Path Args
  • File Opening Safety
  • Environment Variables
  • App-Like Args
• Exception(Error) Handling
  • Where are Errors Handled?
  • What if I don't want that?
  • Which Exceptions Exist?
• Dialogs
  • Message Box
  • Prompt Box
  • Confirmation Box
  • Choice Box
  • Radiolist Box
  • Check Box
  • Styling of dialogs
  • Styling reference sheet
    • Example
• Widgets
  • TextArea
    • Buffer attributes
    • BufferControl attributes
    • Window attributes
    • Other attributes
  • Label
  • Box
  • Button
  • Frame
  • Shadow
• Full screen applications
  • A simple application
  • I/O objects
  • The layout
    • A layered layout architecture
    • Containers and controls
    • Focusing windows
  • Key bindings
    • Global key bindings
    • Modal containers
  • More about the Window class
  • More about buffers and BufferControl
    • Input processors
• Key binding 🗝️
  • List of special keys
  • Binding alt+something, option+something or meta+something
  • Wildcards
  • Attaching a Condition to key bindings
  • ConditionalKeyBindings: Disabling a set of key bindings
  • Merging key bindings
  • Eager
  • Asyncio coroutines
  • Timeouts
  • Recording macros
  • Creating new Vi text objects and operators
  • Processing .inputrc
• Progress bars 📊
  • Simple progress bar
  • Multiple parallel tasks
  • Adding a title and label
  • Formatting the progress bar
  • Adding key bindings and toolbar
• Filters
  • An example
  • Built-in filters
  • Combining filters
  • to_filter
• Styling 🎨
  • Style strings
  • Class names
  • Dot notation in class names
  • Multiple classes in a style sheet
  • Evaluation order of rules in a style sheet
  • Using a dictionary as a style sheet
  • Loading a style from Pygments
  • Merging styles together
  • Color depths
  • Style transformations
• Documenting Scripts
  • Help Texts
  • Documenting Arguments
  • Preventing Rewrapping
  • Truncating Help Texts
  • Meta Variables
  • Command Short Help
  • Help Parameter Customization
• Unicode Support
  • Surrogate Handling

Miscellaneous pages

• License📜
• Changelog
• Appendix

Donate🎁

In order to for us to maintain this project and grow our community of contributors. Donate

Getting Help

Community

For discussions about the usage, development, and the future of quo, please join our Google community

• Community👨‍👩‍👦‍👦

Resources

Bug tracker

If you have any suggestions, bug reports, or annoyances please report them to our issue tracker at Bug tracker or send an email to:

📥 secretum@googlegroups.com