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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cli_ih-0.5.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.2.tar.gz
Algorithm Hash digest
SHA256 47cff856f0deb0244dbfb3985cd25fec9e9de7d128d5c39c2de54f85b4114fbd
MD5 2f6f40495cb7a2bc3d816e0ea1c53425
BLAKE2b-256 5057dfd9f68c57043cee7530905bc6ddf23586deeeeb4d36ba2ea51d01b7036f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cli_ih-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 3.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-py3-none-any.whl
Algorithm Hash digest
SHA256 4894d49d10dd69700f4824d1f17f7c361f8e94fe4777c18c32428d6101799442
MD5 f89ff914815a2924fb3a73e1f97fe224
BLAKE2b-256 f4a536a30105bfe92e58c96d8414e7cfa65bb571b1f4c16d7ebed48a24230ec2

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