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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cli_ih-0.5.4.4.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.4.tar.gz
Algorithm Hash digest
SHA256 19b52f8976a067d19ba7e76c164526d7cd61cf4ec12d5ef120185ed0fc2a3d24
MD5 199c9695643bfcf3da0e878e1538f4ea
BLAKE2b-256 3e57e66b31b0ec6c8aa04d1b304b6fd5affadf08cb5815646199c38c92e63aaa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cli_ih-0.5.4.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2857c33fdf5fce9a752a45251970dd78822a29722e072d752f80d0dcab3d42a4
MD5 22f570fabf7d8d520f968e76ab21c9c3
BLAKE2b-256 87218e3ffd2d3d9e0c07bb9b8cbfde2a2889a41e0208d29cabd8ea44057440b4

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