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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cli_ih-0.5.3.4.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.3.4.tar.gz
Algorithm Hash digest
SHA256 f06e695422c16f2ab72888136f3937016fa1e64497a7dc38fbaba9e27fb772c0
MD5 732dfdd8d2f09506cf136fd44f686b8d
BLAKE2b-256 69993fc819253b76a3ed67bd0aaca7b410dd72ab6908cd38306f0c82b9997b3b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cli_ih-0.5.3.4-py3-none-any.whl
  • Upload date:
  • Size: 7.1 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.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f64f2be65eb9204f1e6f13610f4dc38766581f82baa729bd34de9d81281216a9
MD5 64db3abae76088d9fc8266c34a820ab3
BLAKE2b-256 527f8a43b9b3242e0be5594bc17909f00401ef33875969f606047bdf6bf8f6d7

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