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-attributes

A lexer for .gitattributes files.

git-blame-ignore-revs

A lexer for the file format used by blame.ignoreRevsFile. The de facto name for a repository-wide ignore file is .git-blame-ignore-revs, as recognized by GitHub and potentially other Git hosting services.

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.7.0.tar.gz (8.0 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.7.0-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pygments_git-1.7.0.tar.gz
  • Upload date:
  • Size: 8.0 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.7.0.tar.gz
Algorithm Hash digest
SHA256 15aabd5d5a50d35e30a40499682b71f15b91ab13aa5969de965b2fd0741f8d11
MD5 a965d996a94b70d10418a782041ac1b4
BLAKE2b-256 8454d35805b61f1bc1515a7caacc4b677865a50b2cec5892cfd527eac8e10247

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pygments_git-1.7.0-py3-none-any.whl
  • Upload date:
  • Size: 6.1 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.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9b890c79c0c5b2a3f4ef8e4cd46961ea38ba9f12d879cf53948e982756ecfbc9
MD5 6fd2f690a3d44c0b8247a40b19aee925
BLAKE2b-256 5754ca09f3c86d0f121ffddcae98dc5658997be2767ece546b2f9707c3b7a3b7

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