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.0.tar.gz (3.3 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.0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cli_ih-0.5.4.0.tar.gz
  • Upload date:
  • Size: 3.3 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.0.tar.gz
Algorithm Hash digest
SHA256 6bfa49a2c77e661a46793bbbdebc62b0cfd67de69391bff66c3c23dcb7b874f0
MD5 85f08660c9999eec75a99cda8b892f25
BLAKE2b-256 34cc4ba21fd12f7da748a7e19ac95000d640025e8034c20b15d504ea3437b312

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cli_ih-0.5.4.0-py3-none-any.whl
  • Upload date:
  • Size: 7.1 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 91f76e45174d2835636b1b947014a4e9520af57e52fb94ea036de3df40b852db
MD5 1549dc803661eb9acf5ad8a8f2a286ca
BLAKE2b-256 c50237a5e6d5d9198d8daf4f1508255f8ff708c76ea2759c03d5a852851c1d23

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