Skip to main content
https://img.shields.io/github/actions/workflow/status/adamchainz/pygments-git/main.yml?branch=main&style=for-the-badge https://img.shields.io/badge/Coverage-100%25-success?style=for-the-badge https://img.shields.io/pypi/v/pygments-git.svg?style=for-the-badge https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge pre-commit

Pygments lexers for Git output and files.

Installation

Use pip:

python -m pip install pygments-git

Python 3.8 to 3.12 supported.


Working on a Django project? Improve your skills with one of my books.


Usage

With the package installed, Pygments will autodiscover the below lexers.

When using Pygments directly, you can refer to them by name. Within Sphinx/docutils, you can refer to them in code-block directives:

.. code-block:: git-console

    $ git log --oneline
    82fbbd3 D'oh! Fix math proof
    91e9879 Aye carumba! Grammar mistake
    61c4c08 Cowabunga! Update bibliography

To preview the lexers, open the tests/index.html file within the repository.

git-commit-edit-msg

A lexer for the COMMIT_EDITMSG file that Git opens when you run git commit. It calls out to DiffLexer for highlighting any diff, as added by git commit --verbose.

git-conflict-markers

A lexer for the conflict markers that Git adds to indicate conflicts during a merge. All other text in the file is lexed as plain text.

git-console

A lexer for interactive shell sessions with Git. It calls out to BashLexer for highlighting commands on lines starting with a $ and DiffLexer for highlighting inline diffs.

git-rebase-todo

A lexer for the git-rebase-todo file that Git opens when you run git rebase --interactive. It calls out to BashLexer for highlighting commands on lines starting with x or exerc a $ and DiffLexer for highlighting inline diffs.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pygments_git-1.6.0.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pygments_git-1.6.0-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file pygments_git-1.6.0.tar.gz.

File metadata

  • Download URL: pygments_git-1.6.0.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for pygments_git-1.6.0.tar.gz
Algorithm Hash digest
SHA256 87f85dc5868befa4ecb4cff4491c6ff7f040cd665ce47b04440fa6234487973d
MD5 937f4a41a3ab3d5e915389cf0ff97e75
BLAKE2b-256 7f51a77befb68bc76895287492048e001c7f298d849147ee39e3c23fde9e61fd

See more details on using hashes here.

File details

Details for the file pygments_git-1.6.0-py3-none-any.whl.

File metadata

  • Download URL: pygments_git-1.6.0-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for pygments_git-1.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 65021e4b9b04e11add17c425473d0de0942b66a8b8bbcb9a9f94d238fafd3fff
MD5 862d459eaac3db8ccd468ae231cf3de3
BLAKE2b-256 be763a69f831ac57158647a87e0e93a2a30c03f4d5a450d37d0d143f2741a4ee

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page