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.2.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.2.3-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cli_ih-0.5.2.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.2.3.tar.gz
Algorithm Hash digest
SHA256 5231a263ad5034cd72d165ae1707d762980e97f76a1e53093f7cc304f31eb257
MD5 fe8b36296469863b771f5baf1e117058
BLAKE2b-256 55bfa0128eb35d54950af27e0c26f86b6002e9b9dd8b093092531c2b4c835c9e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cli_ih-0.5.2.3-py3-none-any.whl
  • Upload date:
  • Size: 5.5 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.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a5ed92daf1f4ad4cdc9565394bb7a44dcbfa63d92b5bf272ffbf000f6ac0e134
MD5 0462f0242e11fdeb7dbee09ed142c1ad
BLAKE2b-256 2c8895a687f3b986d2ee94581d5fa35bc9810c4e52300ced8424c02a32a3eaa6

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