A minimal and ridiculously good looking command-line-interface toolkit

Last update: Dec 22, 2022

Overview

Proper CLI

Proper CLI is a Python package for creating beautiful, composable, and ridiculously good looking command-line-user-interfaces without having to write any extra code.

Made for interfacing with humans.
Arbitrary nesting and composition of commands.
Automatic help page generation.
No need to redeclare paramaters and options with decorators, just write Python methods.
The help of a command is its docstring.

Usage

Declare a class that inherits from proper_cli.Cli. Every method/attribute that does not starts with an underscore will be a command.

from proper_cli import Cli

class Manage(Cli):
    def first(self, arg1, arg2=3):
        pass

    def second(self):
        pass

    def _not_a_command(self):
        pass

Then, instance that class and call it.

# run.py
cli = Manage()

if __name__ == "__main__":
    cli()

The class dosctring will be printed at the beginning of the help page.

The arguments can be then passed by position:

python run.py first foo bar

or by name:

python run.py first -arg1 foo -arg2 bar

To pass a True use the name without a value, for a False, prepend the name of the argument with no-:

python run.py first -arg1 -no-arg2

Subcommands

If an attribute is a subclass of proper_cli.Cli, it will be a subcommand:

from proper_cli import Cli

class DBSub(Cli):
    def migrate(self):
        pass

class Manage(Cli):
    # A subcommand
    db = DBSub  # NOT `DBSub()`

Context

You can pass any named argument as context to be used by your commands. This will be stored at the _env attribute.

Example:

>> print(cli._env) {"lorem": "ipsum"}">

>>> cli = Manage(lorem="ipsum")
>>> print(cli._env)
{"lorem": "ipsum"}

An example

This autogenerated help message is the result of running the example below:

# example.py
from proper_cli import Cli


class DBCli(Cli):
    """Database-related commands
    """

    def migrate(self, message):
        """Autogenerate a new revision file.

        This is an alias for "revision --autogenerate".

        Arguments:

        - message: Revision message

        """
        pass

    def branches(self):
        """Show all branches."""
        pass


class MyCli(Cli):
    """Welcome to Proper CLI 3
    """

    def new(self, path, quiet=False):
        """Creates a new Proper application at `path`.

        Arguments:

        - path: Where to create the new application.
        - quiet [False]: Supress all output.
        """
        pass

    def hello(count, name):
        """Simple program that greets NAME for a total of COUNT times."""
        pass

    # A subcommand!
    db = DBCli


cli = MyCli()

if __name__ == "__main__":
    cli()

Coloring the Output

Whenever you output text, you can surround the text with tags to color its output. This is automatically enabled for the docstrings, but you can also have it by using proper_cli.echo() as a drop-in replacement of print().

foo
") # black text on a cyan background echo("
foo") # bold text on a yellow background echo("

foo")">
# green text
echo("
     
      foo
     ")

# black text on a cyan background
echo("
     
      foo"
     )

# bold text on a yellow background
echo("
     
      foo"
     )

Available foreground and background colors are: black, red, green, yellow, blue, magenta, cyan and white.

The available options are: bold, underscore, blink, reverse and conceal.

The closing tag can be replaced by , which revokes all formatting options established by the last opened tag.

Custom styles

These four styles are available by default:

foo ") # yellow text echo(" foo ") # black text on a cyan background echo(" foo ") # white text on a red background echo(" foo ")">

# green text
echo("
   
    foo
   ")

# yellow text
echo("
   
    foo
   ")

# black text on a cyan background
echo("
   
    foo
   ")

# white text on a red background
echo("
   
    foo
   ")

It is possible to define your own styles using the proper_cli.add_style() method:

foo")">

add_style("fire", fg="red", bg="yellow", options=["bold", "blink"])
echo("
   
    foo
   ")

Helpers

Beyond the CLI builder, proper_cli also includes some commonly-used helper functions

`confirm(question, default=False, yes_choices=YES_CHOICES, no_choices=NO_CHOICES)`

Ask a yes/no question via and return their answer.

`ask(question, default=None, alternatives=None)`

Ask a question via input() and return their answer.

FAQ

Why don't just use optparse or argparse?

I find it too verbose.

Why don't just use click?

Are you kidding? Because this looks better and is easier to use and understand.

Why don't just use...?

Because this library fits better my mental model. I hope it matches yours as well.

You might also like...

Textual is a TUI (Text User Interface) framework for Python using Rich as a renderer.

Textual is a TUI (Text User Interface) framework for Python using Rich as a renderer. The end goal is to be able to rapidly create rich termin

17k Jan 2, 2023

sane is a command runner made simple.

22 Jan 3, 2023

A cross platform package to do curses-like operations, plus higher level APIs and widgets to create text UIs and ASCII art animations

ASCIIMATICS Asciimatics is a package to help people create full-screen text UIs (from interactive forms to ASCII animations) on any platform. It is li

3.2k Jan 9, 2023

Rich is a Python library for rich text and beautiful formatting in the terminal.

Rich 中文 readme • lengua española readme • Läs på svenska Rich is a Python library for rich text and beautiful formatting in the terminal. The Rich API

41.4k Jan 2, 2023

Python and tab completion, better together.

argcomplete - Bash tab completion for argparse Tab complete all the things! Argcomplete provides easy, extensible command line tab completion of argum

1.1k Jan 8, 2023

A drop-in replacement for argparse that allows options to also be set via config files and/or environment variables.

ConfigArgParse Overview Applications with more than a handful of user-settable options are best configured through a combination of command line args,

634 Dec 22, 2022

A module for parsing and processing commands.

cmdtools A module for parsing and processing commands. Installation pip install --upgrade cmdtools-py install latest commit from GitHub pip install g

1 Aug 14, 2022

A minimal and ridiculously good looking command-line-interface toolkit

Proper CLI Proper CLI is a Python package for creating beautiful, composable, and ridiculously good looking command-line-user-interfaces without havin

2 Dec 22, 2022

A command-line based, minimal torrent streaming client made using Python and Webtorrent-cli. Stream your favorite shows straight from the command line.

A command-line based, minimal torrent streaming client made using Python and Webtorrent-cli. Installation pip install -r requirements.txt It use

17 Dec 11, 2022

Command-line tool for looking up colors and palettes.

Colorpedia Colorpedia is a command-line tool for looking up colors, shades and palettes. Supported color models: HEX, RGB, HSL, HSV, CMYK. Requirement

282 Dec 27, 2022

Python composable command line interface toolkit

$ click_ Click is a Python package for creating beautiful command line interfaces in a composable way with as little code as necessary. It's the "Comm

13.3k Dec 31, 2022

Quo is a Python based toolkit for writing Command-Line Interface(CLI) applications.

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.

16 Oct 15, 2022

Dear PyGui: A fast and powerful Graphical User Interface Toolkit for Python with minimal dependencies

(This library is available under a free and permissive license however, if you Enjoy Dear PyGui please consider becoming a Sponsor) Dear PyGui is a si

9.4k Jan 4, 2023

Dear PyGui: A fast and powerful Graphical User Interface Toolkit for Python with minimal dependencies

(This library is available under a free and permissive license however, if you Enjoy Dear PyGui please consider becoming a Sponsor) Dear PyGui is a si

9.4k Jan 7, 2023

A command-line based, minimal torrent streaming client made using Python and Webtorrent-cli.

ABOUT A command-line based, minimal torrent streaming client made using Python and Webtorrent-cli. Installation pip install -r requirements.txt It use

17 Dec 11, 2022

Minimal command-line music player written in Python

pyms Minimal command-line music player written in Python. Designed with elegance and minimalism. Resizes dynamically with your terminal. Dependencies

12 Sep 23, 2022

Minimal diffusion models - Minimal code and simple experiments to play with Denoising Diffusion Probabilistic Models (DDPMs)

Minimal code and simple experiments to play with Denoising Diffusion Probabilist

16 Oct 6, 2022

Py2neo is a comprehensive toolkit for working with Neo4j from within Python applications or from the command line.

Py2neo Py2neo is a client library and toolkit for working with Neo4j from within Python applications and from the command line. The library supports b

1.2k Jan 2, 2023

coala provides a unified command-line interface for linting and fixing all your code, regardless of the programming languages you use.

"Always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live." ― John F. Woods coala provides a

3.4k Jan 2, 2023

Releases(1.0)

1.0(Dec 30, 2021)

Full Changelog: https://github.com/jpsca/proper-cli/commits/1.0
Source code(tar.gz)
Source code(zip)

A minimal and ridiculously good looking command-line-interface toolkit

Related tags

Overview

Proper CLI

Usage

Subcommands

Context

An example

Coloring the Output

Custom styles

Helpers

confirm(question, default=False, yes_choices=YES_CHOICES, no_choices=NO_CHOICES)

ask(question, default=None, alternatives=None)

FAQ

Why don't just use optparse or argparse?

Why don't just use click?

Why don't just use...?

You might also like...

Textual is a TUI (Text User Interface) framework for Python using Rich as a renderer.

sane is a command runner made simple.

A cross platform package to do curses-like operations, plus higher level APIs and widgets to create text UIs and ASCII art animations

Rich is a Python library for rich text and beautiful formatting in the terminal.

Python and tab completion, better together.

A drop-in replacement for argparse that allows options to also be set via config files and/or environment variables.

A module for parsing and processing commands.

A minimal and ridiculously good looking command-line-interface toolkit

A command-line based, minimal torrent streaming client made using Python and Webtorrent-cli. Stream your favorite shows straight from the command line.

Command-line tool for looking up colors and palettes.

Python composable command line interface toolkit

Quo is a Python based toolkit for writing Command-Line Interface(CLI) applications.

Dear PyGui: A fast and powerful Graphical User Interface Toolkit for Python with minimal dependencies

Dear PyGui: A fast and powerful Graphical User Interface Toolkit for Python with minimal dependencies

A command-line based, minimal torrent streaming client made using Python and Webtorrent-cli.

Minimal command-line music player written in Python

Minimal diffusion models - Minimal code and simple experiments to play with Denoising Diffusion Probabilistic Models (DDPMs)

Py2neo is a comprehensive toolkit for working with Neo4j from within Python applications or from the command line.

coala provides a unified command-line interface for linting and fixing all your code, regardless of the programming languages you use.

Releases(1.0)

1.0(Dec 30, 2021)

Owner

Juan-Pablo Scaletti

A module for parsing and processing commands.

Simple cross-platform colored terminal text in Python

CalcuPy 📚 Create console-based calculators in a few lines of code.

A minimal and ridiculously good looking command-line-interface toolkit

Python Command-line Application Tools

Cement is an advanced Application Framework for Python, with a primary focus on CLI

A simple terminal Christmas tree made with Python

Rich is a Python library for rich text and beautiful formatting in the terminal.

sane is a command runner made simple.

Color text streams with a polished command line interface

Pythonic command line arguments parser, that will make you smile

Library for building powerful interactive command line applications in Python

Command line animations based on the state of the system

A fast, stateless http slash commands framework for scale. Built by the Crunchy bot team.

Terminalcmd - a Python library which can help you to make your own terminal program with high-intellegence instruments

Python Fire is a library for automatically generating command line interfaces (CLIs) from absolutely any Python object.

A thin, practical wrapper around terminal capabilities in Python

Typer, build great CLIs. Easy to code. Based on Python type hints.

Cleo allows you to create beautiful and testable command-line interfaces.

Corgy allows you to create a command line interface in Python, without worrying about boilerplate code

`confirm(question, default=False, yes_choices=YES_CHOICES, no_choices=NO_CHOICES)`

`ask(question, default=None, alternatives=None)`