CliKit

0.6.2 · maintenance · verified Sun Apr 12

CliKit is a Python library providing a collection of utilities to build robust and testable command-line interfaces. It serves as a foundational component for other CLI frameworks like Cleo. The library is currently at version 0.6.2, with its last release in June 2020, indicating a maintenance phase following a period of active development in late 2019 and early 2020.

Warnings

breaking Version 0.4.0 introduced changes to how event names are stored and exposed.
Fix: Review any custom event listeners or code interacting with internal event name structures and update them to conform to the new pattern.
gotcha Default progress bar update rate was limited to a maximum of every 100ms in v0.6.1.
Fix: If faster progress bar updates are required, configure the update rate using the `min_seconds_between_redraws()` method on the progress bar instance.
gotcha Progress bars and indicators passed an `IO` instance will now default to using the error output stream (`stderr`) instead of standard output (`stdout`).
Fix: Explicitly pass an `Output` instance (if available, which typically wraps `stdout`) or ensure your `IO` instance is configured to use the desired output stream if progress should not appear on `stderr`.
gotcha Compatibility with the `pastel` dependency was a known issue that required fixes in v0.4.2.
Fix: Ensure you are using `clikit` v0.4.2 or newer with compatible versions of `pastel` to avoid rendering or display issues.
gotcha Early versions (e.g., 0.4.1, 0.4.3) had specific fixes for Python 2.7 related to encoding errors in questions and exception trace rendering.
Fix: While `clikit` supports Python 2.7, it is recommended to use the latest version (0.6.2) for improved Python 2.7 stability, or ideally migrate to Python 3 for better overall support and future compatibility.

Install

pip install clikit Install latest version

Imports

Application

from clikit.api.application import Application

Command
```
from clikit.api.command import Command
```
Argument
```
from clikit.api.args import Argument
```
Option
```
from clikit.api.args import Option
```
IO
```
from clikit.ui.io import IO
```
While `Output` exists, `IO` is a more general interface for input/output, often used directly for `write_line` and accessing arguments, especially with progress bar changes in v0.6.1.

Quickstart

This example demonstrates how to create a simple CLI application with a single 'hello' command that accepts a required argument for a name and an optional flag to make the greeting loud. It initializes an `Application`, adds the custom `HelloCommand`, and runs the application.

from clikit.api.application import Application
from clikit.api.command import Command
from clikit.api.args import Argument, Option
from clikit.ui.io import IO


class HelloCommand(Command):
    def __init__(self):
        super().__init__()
        self.set_name("hello")
        self.set_description("Greets the given name.")
        self.add_argument(Argument("name", Argument.REQUIRED, "The name to greet."))
        self.add_option(Option("loud", "l", Option.NO_VALUE, "Make the greeting loud."))

    def handle(self, io: IO):
        name = io.args.get("name")
        loud = io.args.get("loud")

        message = f"Hello, {name}!"
        if loud:
            message = message.upper()

        io.write_line(message)


if __name__ == "__main__":
    application = Application("My CLI App", "1.0.0")
    application.add_command(HelloCommand())
    application.run()

view raw JSON →