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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cli_ih-0.5.2.1.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.1.tar.gz
Algorithm Hash digest
SHA256 7af3275b7e5039b518185a4eb6503364d145acc0345c8897bafa2e919aa5c32e
MD5 2634aaaf10d3378b06ef192692e501bf
BLAKE2b-256 ed9d3a1d11ad5f0c838734b0980054856002d2fa1a8c58068cf4d6c371a43c52

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cli_ih-0.5.2.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dd7625189acd3cef36cefc2cdd25c56e09d6de1372a9af955f3173becc5ad2fe
MD5 271d4022c13fe2af4b325fb3e393aaeb
BLAKE2b-256 85f9819504d76e628db9eb2ea587918baee5620fb140bff1755d6a79c1c04b05

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