Metadata-Version: 2.1
Name: climux
Version: 0.1.1
Summary: Library for writing command-line interfaces
Home-page: https://github.com/lggruspe/climux
Author: Levi Gruspe
Author-email: mail.levig@gmail.com
License: UNKNOWN
Description: Climux
        ======
        
        ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/lggruspe/climux/Python%20package)
        [![PyPI](https://img.shields.io/pypi/v/climux)](https://pypi.org/project/climux/)
        [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/climux)](https://pypi.org/project/climux/)
        [![GitHub](https://img.shields.io/github/license/lggruspe/climux)](./LICENSE)
        
        Library for writing command-line interfaces
        
        Installation
        ------------
        
        ```bash
        pip install climux
        ```
        
        Usage
        -----
        
        ```python
        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](./examples/).
        
        Features
        --------
        
        - Subcommands
        - Generate CLI help and options from function signature and docstring
        - Automatic dispatch to command handling functions
        
        License
        -------
        
        [MIT](./LICENSE).
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Console
Requires-Python: >=3.7
Description-Content-Type: text/markdown
