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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cli_ih-0.5.4.5.tar.gz
  • Upload date:
  • Size: 3.5 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.5.tar.gz
Algorithm Hash digest
SHA256 f6bca40438672fba5b226539e76777da9c96543852a9c20382cc2eb9e3d55bef
MD5 e28fc41ce7fa8dbfd0b98fc30ccd83f4
BLAKE2b-256 6a8b12cfdaf2aed9a65a9cf51392407afbd8708166ef68501d968e9f8f9ca377

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cli_ih-0.5.4.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 03abe19142a2b18b96a9f8d8232952c94430706f741a51c47c84188a5d939b34
MD5 caaac1d1affb6656e19de6923fdb91d3
BLAKE2b-256 f4dd41bcdeadff3d6cca326e139eb923f82e978b3420aa2f35af2bdbb6db49e3

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