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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cli_ih-0.5.3.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.3.tar.gz
Algorithm Hash digest
SHA256 59947e42e17ac5f5329394815515a685ab2feb7f9a34ea494fbc991deb223210
MD5 e0634ce62bb603ca228a98d37d8b1eb8
BLAKE2b-256 4449e92bcb5b2f4ca98345f5936a14b1452cde9ee30078ffcc40d8862a7c0fc8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cli_ih-0.5.3-py3-none-any.whl
  • Upload date:
  • Size: 5.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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 200bc11bb13d02cfea6a17cdedd932cc1ceceaa33f4dd418e8b587bc286c2af2
MD5 188d0403f2112047de38dd173f34db72
BLAKE2b-256 87d9b4978dd823503f10d1643de3f5014819e805a0e760c62470aed8fa8a64f7

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