https://github.com/domdfcoding/highlight

Highlight text on the command line.
https://github.com/domdfcoding/highlight

cat console highlight python

Last synced: 21 days ago
JSON representation

Highlight text on the command line.

• Host: GitHub
• URL: https://github.com/domdfcoding/highlight
• Owner: domdfcoding
• License: mit
• Created: 2021-07-28T08:33:45.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-08-12T14:33:48.000Z (3 months ago)
• Last Synced: 2024-08-12T16:53:50.140Z (3 months ago)
• Topics: cat, console, highlight, python
• Language: Python
• Homepage: https://highlight.readthedocs.io/en/latest
• Size: 5.08 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
==========

highlight

==========

.. start short_desc

**Highlight text on the command line.**

.. end short_desc

.. start shields

.. list-table::

	:stub-columns: 1

	:widths: 10 90

	* - Docs

	  - |docs| |docs_check|

	* - Tests

	  - |actions_linux| |actions_macos| |coveralls|

	* - Activity

	  - |commits-latest| |commits-since| |maintained|

	* - QA

	  - |codefactor| |actions_flake8| |actions_mypy|

	* - Other

	  - |license| |language| |requires|

.. |docs| image:: https://img.shields.io/readthedocs/highlight/latest?logo=read-the-docs

	:target: https://highlight.readthedocs.io/en/latest

	:alt: Documentation Build Status

.. |docs_check| image:: https://github.com/domdfcoding/highlight/workflows/Docs%20Check/badge.svg

	:target: https://github.com/domdfcoding/highlight/actions?query=workflow%3A%22Docs+Check%22

	:alt: Docs Check Status

.. |actions_linux| image:: https://github.com/domdfcoding/highlight/workflows/Linux/badge.svg

	:target: https://github.com/domdfcoding/highlight/actions?query=workflow%3A%22Linux%22

	:alt: Linux Test Status

.. |actions_macos| image:: https://github.com/domdfcoding/highlight/workflows/macOS/badge.svg

	:target: https://github.com/domdfcoding/highlight/actions?query=workflow%3A%22macOS%22

	:alt: macOS Test Status

.. |actions_flake8| image:: https://github.com/domdfcoding/highlight/workflows/Flake8/badge.svg

	:target: https://github.com/domdfcoding/highlight/actions?query=workflow%3A%22Flake8%22

	:alt: Flake8 Status

.. |actions_mypy| image:: https://github.com/domdfcoding/highlight/workflows/mypy/badge.svg

	:target: https://github.com/domdfcoding/highlight/actions?query=workflow%3A%22mypy%22

	:alt: mypy status

.. |requires| image:: https://dependency-dash.repo-helper.uk/github/domdfcoding/highlight/badge.svg

	:target: https://dependency-dash.repo-helper.uk/github/domdfcoding/highlight/

	:alt: Requirements Status

.. |coveralls| image:: https://img.shields.io/coveralls/github/domdfcoding/highlight/master?logo=coveralls

	:target: https://coveralls.io/github/domdfcoding/highlight?branch=master

	:alt: Coverage

.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/highlight?logo=codefactor

	:target: https://www.codefactor.io/repository/github/domdfcoding/highlight

	:alt: CodeFactor Grade

.. |license| image:: https://img.shields.io/github/license/domdfcoding/highlight

	:target: https://github.com/domdfcoding/highlight/blob/master/LICENSE

	:alt: License

.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/highlight

	:alt: GitHub top language

.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/highlight/v0.2.0

	:target: https://github.com/domdfcoding/highlight/pulse

	:alt: GitHub commits since tagged version

.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/highlight

	:target: https://github.com/domdfcoding/highlight/commit/master

	:alt: GitHub last commit

.. |maintained| image:: https://img.shields.io/maintenance/yes/2024

	:alt: Maintenance

.. end shields

Installation

--------------

.. start installation

``highlight`` can be installed from GitHub.

To install with ``pip``:

.. code-block:: bash

	$ python -m pip install git+https://github.com/domdfcoding/highlight

.. end installation