Metadata-Version: 2.1
Name: click-help-colors
Version: 0.9
Summary: Colorization of help messages in Click
Home-page: https://github.com/r-m-n/click-help-colors
License: MIT
Description: =================
        click-help-colors
        =================
        
        |build| |pypi| |downloads|
        
        Colorization of help messages in Click_.
        
        Usage
        -----
        
        .. code:: python
        
          import click
          from click_help_colors import HelpColorsGroup, HelpColorsCommand
        
          @click.group(
              cls=HelpColorsGroup,
              help_headers_color='yellow',
              help_options_color='green'
          )
          def cli():
              pass
        
          @cli.command()
          @click.option('--count', default=1, help='Some number.')
          def command1(count):
              click.echo('command 1')
        
          @cli.command(
              cls=HelpColorsCommand,
              help_options_color='blue'
          )
          @click.option('--name', help='Some string.')
          def command2(name):
              click.echo('command 2')
        
        .. code-block:: console
        
            $ python example.py --help
        
        .. image:: https://raw.githubusercontent.com/r-m-n/click-help-colors/master/examples/screenshots/1.png
        
        .. code-block:: console
        
            $ python example.py command1 --help
        
        .. image:: https://raw.githubusercontent.com/r-m-n/click-help-colors/master/examples/screenshots/2.png
        
        .. code-block:: console
        
            $ python example.py command2 --help
        
        .. image:: https://raw.githubusercontent.com/r-m-n/click-help-colors/master/examples/screenshots/3.png
        
        .. code:: python
        
          import click
          from click_help_colors import HelpColorsGroup, HelpColorsCommand
        
          @click.group(
              cls=HelpColorsGroup,
              help_headers_color='yellow',
              help_options_color='green',
              help_options_custom_colors={'command3': 'red', 'command4': 'cyan'}
          )
          def cli():
              pass
        
        
          @cli.command(
              cls=HelpColorsCommand,
              help_headers_color=None,
              help_options_color=None,
              help_options_custom_colors={'--count': 'red', '--subtract': 'green'}
          )
          @click.option('--count', default=1, help='Count help text.')
          @click.option('--add', default=1, help='Add help text.')
          @click.option('--subtract', default=1, help='Subtract help text.')
          def command1(count, add, subtract):
              """A command"""
              click.echo('command 1')
        
          ...
        
        .. code-block:: console
        
            $ python example_with_custom_colors.py --help
        
        .. image:: https://raw.githubusercontent.com/r-m-n/click-help-colors/master/examples/screenshots/4.png
        
        .. code-block:: console
        
            $ python example_with_custom_colors.py --help
        
        .. image:: https://raw.githubusercontent.com/r-m-n/click-help-colors/master/examples/screenshots/5.png
        
        .. code:: python
        
            from click_help_colors import version_option
        
            @click.group()
            def cli():
                pass
        
            @cli.command()
            @version_option(
                version='1.0',
                prog_name='example',
                message_color='green'
            )
            def cmd1():
                pass
        
            @cli.command()
            @version_option(
                version='1.0',
                prog_name='example',
                version_color='green',
                prog_name_color='yellow'
            )
            def cmd2():
                pass
        
            @cli.command()
            @version_option(
                version='1.0',
                prog_name='example',
                version_color='green',
                prog_name_color='white',
                message='%(prog)s %(version)s\n   python=3.7',
                message_color='bright_black'
            )
            def cmd3():
                pass
        
        .. image:: https://raw.githubusercontent.com/r-m-n/click-help-colors/master/examples/screenshots/6.png
        
        Installation
        ------------
        
        With ``pip``:
        
        .. code-block:: console
        
            $ pip install click-help-colors
        
        From source:
        
        .. code-block:: console
        
            $ git clone https://github.com/r-m-n/click-help-colors.git
            $ cd click-help-colors
            $ python setup.py install
        
        .. _Click: http://click.pocoo.org/
        
        
        .. |pypi| image:: https://img.shields.io/pypi/v/click-help-colors
            :alt: PyPI
        
        .. |build| image:: https://travis-ci.com/click-contrib/click-help-colors.svg?branch=master
            :target: https://travis-ci.com/click-contrib/click-help-colors
        
        .. |downloads| image:: https://img.shields.io/pypi/dm/click-help-colors
            :alt: PyPI - Downloads
        
Keywords: click
Platform: UNKNOWN
Provides-Extra: dev
