Skip to main content

Library for writing command-line interfaces

Project description

Climux

GitHub Workflow Status PyPI PyPI - Python Version GitHub

Library for writing command-line interfaces

Installation

pip install climux

Usage

from climux import Cli, Command

def hello(name="stranger"):
    """Say hello."""
    return f"Hello, {name}!"

cli = Cli("hello", description="Hello world app.")
cli.add(Command(hello))
cli.run()

See examples.

Features

  • Subcommands
  • Generate CLI help and options from function signature and docstring
  • Automatic dispatch to command handling functions

License

MIT.

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

climux-0.1.1.tar.gz (10.2 kB view hashes)

Uploaded Source

Built Distribution

climux-0.1.1-py3-none-any.whl (15.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page