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.7 to 3.11 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.3.0.tar.gz (10.2 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.3.0-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pygments_git-1.3.0.tar.gz
Algorithm Hash digest
SHA256 4b1931d657408a50697125ca2f5f6a7126ff81b15949cf56b410a6e5c3ea3f0e
MD5 b9766f7a59f6512f81b883312906c725
BLAKE2b-256 9f312b4a41ab92ab785afcfcb189ca4ba81c476eaa25f90f0f3ed351636e03e6

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pygments_git-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 893924735dc566997da845c7f40204bda7f72bb4d4e142f7c771895292f10061
MD5 3df70797e05c9faeaa1306d22d5e457d
BLAKE2b-256 072e9dae4f96e5340c090b9bda5873d54d113d2fe86f9fbff0dc1aea032bafe5

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