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.1.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.1-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cli_ih-0.5.4.1.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.1.tar.gz
Algorithm Hash digest
SHA256 31b615120b98b5fc0225925f3d214c70b0d140759b0e665822dc7995299b5c08
MD5 0b494ea84be6e23db13cf88396c83111
BLAKE2b-256 7ad22020c9a04fae12389af2a02611142c64f4a1eadda2fcb0e29929789a497f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cli_ih-0.5.4.1-py3-none-any.whl
  • Upload date:
  • Size: 7.2 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 810248d93bec8525b31f1b139b333555b995e5ea7dddc8fa4c191666ae0ab12b
MD5 e7c2d849bcbe211e3dbff21719516ba5
BLAKE2b-256 7791a032f8f54192e7c7f6825e894a3625c7354b68ed8f277823b4fb4412233f

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