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.2.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.3.2-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cli_ih-0.5.3.2.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.3.2.tar.gz
Algorithm Hash digest
SHA256 181263336becf1af4b83a4f914686ef9a851195d2eb965e10f50258a5f21f98a
MD5 e6668ca6422b493a77ff3b6fcd05fe70
BLAKE2b-256 9ea487f39a3dbd9278f3712d666ab3796a8a111c3e466bc748de17d1e487f9a9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cli_ih-0.5.3.2-py3-none-any.whl
  • Upload date:
  • Size: 7.3 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3076b62fddc05ecc1cb3177657e2f9ace6c9571a3bc109a59a9ff704637e5457
MD5 1a14718d1f5a056cf59f47469522a7c6
BLAKE2b-256 1caac019a1c598ccd4b246af18a565b6d79240d00eaaeb0d0cf992b3bac74082

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