Metadata-Version: 1.2
Name: cloup
Version: 0.1.1
Summary: Option groups for pallets/click
Home-page: https://github.com/janLuke/cloup
Author: Gianluca Gippetto
Author-email: gianluca.gippetto@gmail.com
License: MIT license
Description: =====
        cloup
        =====
        
        .. image:: https://img.shields.io/pypi/v/cloup.svg
                :target: https://pypi.python.org/pypi/cloup
        
        .. image:: https://img.shields.io/travis/janLuke/cloup.svg
                :target: https://travis-ci.com/janLuke/cloup
        
        .. comment:
            .. image:: https://readthedocs.org/projects/cloup/badge/?version=latest
                    :target: https://cloup.readthedocs.io/en/latest/?badge=latest
                    :alt: Documentation Status
        
        
        Adds option groups to `pallets/click <https://github.com/pallets/click>`_.
        
        This package only affects how the command help is formatted, it doesn't
        (and never will) allow to specify constraints on option groups. Look at
        `click-option-group <https://github.com/click-contrib/click-option-group>`_ if
        you want that.
        
        * Free software: MIT license
        
        Example
        -------
        The following code
        
        .. code-block:: python
        
            import cloup
            from cloup import option_group
        
        
            @cloup.command('clouptest')
            @option_group('Option group A', [
                cloup.option('--a1', help='1st option of group A'),
                cloup.option('--a2', help='2nd option of group A'),
                cloup.option('--a3', help='3rd option of group A')],
                help='This is a useful description of group A',
            )
            @option_group('Option group B', [
                cloup.option('--b1', help='1st option of group B'),
                cloup.option('--b2', help='end option of group B'),
                cloup.option('--b3', help='3rd option of group B'),
            ])
            @cloup.option('--opt1', help='an uncategorized option')
            @cloup.option('--opt2', help='another uncategorized option')
            def cli(**kwargs):
                """ A CLI that does nothing. """
                print(kwargs)
        
        
            if __name__ == '__main__':
                cli()
        
        ... will print::
        
            Usage: clouptest [OPTIONS]
        
              A CLI that does nothing.
        
            Option group A:
              This is a useful description of group A
              --a1 TEXT  1st option of group A
              --a2 TEXT  2nd option of group A
              --a3 TEXT  3rd option of group A
        
            Option group B:
              --b1 TEXT  1st option of group B
              --b2 TEXT  end option of group B
              --b3 TEXT  3rd option of group B
        
            Other options:
              --opt1 TEXT  an uncategorized option
              --opt2 TEXT  another uncategorized option
              --help       Show this message and exit.
        
        Credits
        -------
        
        I started from the code writte by `@chrisjsewell <https://github.com/chrisjsewell>`_
        in `this comment <https://github.com/pallets/click/issues/373#issuecomment-515293746>`_.
        
        This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        
        =======
        History
        =======
        
        0.1.0 (2020-02-25)
        ------------------
        
        * First release on PyPI.
        
Keywords: cloup
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5
