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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cli_ih-0.5.4.2.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.2.tar.gz
Algorithm Hash digest
SHA256 5a20a6213b1b48cad3d3e85ed4fbc5d8f13745b8e231ccebc3ed4e1e3a907ebf
MD5 d9d8cb53f768fe6487a1e04641a14cbc
BLAKE2b-256 0d05622607f86d4071b636ddfca7bcd2b0138d9d4e5bb1bc8da6c85a8e01e88e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cli_ih-0.5.4.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 501989e0133521946550f43fe7ae43abe534ae3e75599866d814a9c21dacfdc3
MD5 5f16cd5aec889d31818f7858215400de
BLAKE2b-256 55d10ead1cf93a33cc4de0f350b2522300396fae9dae6142bf656efb58d04e98

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