Skip to main content

A background command handler for python's command line interface.

Project description

InputHandler Library

A lightweight Python library for creating interactive command-line interfaces with custom command registration and input handling. It supports threaded input processing and includes enhanced logging with color-coded output.

Features

  • Command registration system with descriptions
  • Threaded or non-threaded input handling
  • Colored logging with support for debug mode
  • Built-in help, debug, and exit commands
  • Error handling for missing or invalid command arguments

Installation

pip install cli_ih

Quick Start

from cli_ih import InputHandler

def greet(args):
    print(f"Hello, {' '.join(args)}!")

handler = InputHandler()
handler.register_command("greet", greet, "Greets the user. Usage: greet [name]")
handler.start()

# Now type commands like:
# > greet world
# > help
# > debug
# > exit

Additional Info

  • You can also import the logging module from cli-ih to use the same config as the module
  • You can provide the thread_mode param to the InputHandler class to set if it shoud run in a thread or no. (If you are using the cli-ih module on its own without any other background task set thread_mode=False to false)
  • You can also provide a cursor param to the InputHandler class to set the cli cursor (default cusor is empty)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cli_ih-0.5.4.3.tar.gz (3.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cli_ih-0.5.4.3-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

Details for the file cli_ih-0.5.4.3.tar.gz.

File metadata

  • Download URL: cli_ih-0.5.4.3.tar.gz
  • Upload date:
  • Size: 3.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.0

File hashes

Hashes for cli_ih-0.5.4.3.tar.gz
Algorithm Hash digest
SHA256 0ddd111e512a7285de4b809f0861d7a6569905b4e66833816d12968282b289dd
MD5 1e4534a4b4db41dfef3f2f0bcae3d72d
BLAKE2b-256 6470b5d8784395918d06f42fb9e07cf9850060006ee37a646d4eeb98283785e1

See more details on using hashes here.

File details

Details for the file cli_ih-0.5.4.3-py3-none-any.whl.

File metadata

  • Download URL: cli_ih-0.5.4.3-py3-none-any.whl
  • Upload date:
  • Size: 3.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.0

File hashes

Hashes for cli_ih-0.5.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f50963cfae7d64be7b84ad443a9188e67a0615e1c2a17f1cb12a065d28c8b3cb
MD5 d73446ea2d12d77e26752de86f05e71f
BLAKE2b-256 6ba2aa5778b235fa01ab1ea3d0d2eee3fdc9652466f916270c3a4cb837fd5270

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page