https://github.com/click-contrib/click-help-colors

Colorization of help messages in Click :art:
https://github.com/click-contrib/click-help-colors

cli click python python-click

Last synced: 6 months ago
JSON representation

Colorization of help messages in Click :art:

• Host: GitHub
• URL: https://github.com/click-contrib/click-help-colors
• Owner: click-contrib
• License: mit
• Created: 2016-09-01T21:05:34.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2025-03-08T10:55:17.000Z (about 1 year ago)
• Last Synced: 2025-10-21T20:57:07.965Z (7 months ago)
• Topics: cli, click, python, python-click
• Language: Python
• Homepage:
• Size: 275 KB
• Stars: 89
• Watchers: 3
• Forks: 14
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
=================

click-help-colors

=================

|tests| |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/click-contrib/click-help-colors/master/examples/screenshots/1.png

.. code-block:: console

    $ python example.py command1 --help

.. image:: https://raw.githubusercontent.com/click-contrib/click-help-colors/master/examples/screenshots/2.png

.. code-block:: console

    $ python example.py command2 --help

.. image:: https://raw.githubusercontent.com/click-contrib/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/click-contrib/click-help-colors/master/examples/screenshots/4.png

.. code-block:: console

    $ python example_with_custom_colors.py command1 --help

.. image:: https://raw.githubusercontent.com/click-contrib/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/click-contrib/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/click-contrib/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

.. |downloads| image:: https://img.shields.io/pypi/dm/click-help-colors

    :alt: PyPI - Downloads

.. |tests| image:: https://github.com/click-contrib/click-help-colors/workflows/Tests/badge.svg

    :alt: Tests