[![build status](https://github.com/asottile/pygments-pre-commit/actions/workflows/main.yml/badge.svg)](https://github.com/asottile/pygments-pre-commit/actions/workflows/main.yml)
[![Build Status](https://github.com/asottile/pygments-pre-commit/workflows/deploy/badge.svg)](https://github.com/asottile/pygments-pre-commit/actions)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/asottile/pygments-pre-commit/main.svg)](https://results.pre-commit.ci/latest/github/asottile/pygments-pre-commit/main)
pygments-pre-commit
===================
A pygments lexer for pre-commit output
See [some demos](https://asottile.github.io/pygments-pre-commit)!
Or [see it in action on pre-commit.com](https://pre-commit.com/#usage).
## Installation
```bash
pip install pygments-pre-commit
```
## Usage
This library provides a pygments lexer called `pre-commit`.
```rst
.. code-block:: pre-commit
$ pre-commit run
passing..................................................................Passed
failing..................................................................Failed
- hook id: failing
- exit code: 1
['.pre-commit-config.yaml', 'a']
skipped (no files)...................................(no files to check)Skipped
skip me.................................................................Skipped
```
This library also provides a sphinx extension. It can be enabled by adding
`'pygments_pre_commit'` to the `extensions` setting in your `conf.py`.
The colors can be tweaked using the sphinx setting (in `conf.py`)
`pygments_pre_commit_ansi_colors`:
```python
pygments_pre_commit_ansi_colors = {
'Black': '#2e3436',
'Cyan': '#06989a',
'Green': '#4e9a06',
'Red': '#c00',
'Yellow': '#c4A000',
'Faint': '#ccc',
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/asottile/pygments-pre-commit",
"name": "pygments-pre-commit",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Anthony Sottile",
"author_email": "asottile@umich.edu",
"download_url": "https://files.pythonhosted.org/packages/f1/a5/eeeb6d10211af2bb1a1dc67d4d9dcabb8e4d19d1d6a65a150e18c6e8261d/pygments_pre_commit-2.3.0.tar.gz",
"platform": null,
"description": "[![build status](https://github.com/asottile/pygments-pre-commit/actions/workflows/main.yml/badge.svg)](https://github.com/asottile/pygments-pre-commit/actions/workflows/main.yml)\n[![Build Status](https://github.com/asottile/pygments-pre-commit/workflows/deploy/badge.svg)](https://github.com/asottile/pygments-pre-commit/actions)\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/asottile/pygments-pre-commit/main.svg)](https://results.pre-commit.ci/latest/github/asottile/pygments-pre-commit/main)\n\npygments-pre-commit\n===================\n\nA pygments lexer for pre-commit output\n\nSee [some demos](https://asottile.github.io/pygments-pre-commit)!\nOr [see it in action on pre-commit.com](https://pre-commit.com/#usage).\n\n## Installation\n\n```bash\npip install pygments-pre-commit\n```\n\n## Usage\n\nThis library provides a pygments lexer called `pre-commit`.\n\n```rst\n.. code-block:: pre-commit\n\n $ pre-commit run\n passing..................................................................Passed\n failing..................................................................Failed\n - hook id: failing\n - exit code: 1\n\n ['.pre-commit-config.yaml', 'a']\n\n skipped (no files)...................................(no files to check)Skipped\n skip me.................................................................Skipped\n```\n\nThis library also provides a sphinx extension. It can be enabled by adding\n`'pygments_pre_commit'` to the `extensions` setting in your `conf.py`.\n\nThe colors can be tweaked using the sphinx setting (in `conf.py`)\n`pygments_pre_commit_ansi_colors`:\n\n```python\npygments_pre_commit_ansi_colors = {\n 'Black': '#2e3436',\n 'Cyan': '#06989a',\n 'Green': '#4e9a06',\n 'Red': '#c00',\n 'Yellow': '#c4A000',\n 'Faint': '#ccc',\n}\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A pygments lexer for pre-commit output.",
"version": "2.3.0",
"project_urls": {
"Homepage": "https://github.com/asottile/pygments-pre-commit"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0d63bc41b45b54afc4d2f9c6f99c8634b3c2345c78f1643644b0694b16aba7a6",
"md5": "49bea44fca6c33421d051c243b762365",
"sha256": "3145697184dcc69288de22227a0bd99d52cb3dc95a72e7a56d3c6096ced13d85"
},
"downloads": -1,
"filename": "pygments_pre_commit-2.3.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "49bea44fca6c33421d051c243b762365",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 4135,
"upload_time": "2023-10-30T22:54:16",
"upload_time_iso_8601": "2023-10-30T22:54:16.357369Z",
"url": "https://files.pythonhosted.org/packages/0d/63/bc41b45b54afc4d2f9c6f99c8634b3c2345c78f1643644b0694b16aba7a6/pygments_pre_commit-2.3.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f1a5eeeb6d10211af2bb1a1dc67d4d9dcabb8e4d19d1d6a65a150e18c6e8261d",
"md5": "11538cf79f8e427ed9713b7e01bd89ca",
"sha256": "d937c99eb4ffc0545e1f6ececf3aa424b11de903490a8494f1af637ad060af4c"
},
"downloads": -1,
"filename": "pygments_pre_commit-2.3.0.tar.gz",
"has_sig": false,
"md5_digest": "11538cf79f8e427ed9713b7e01bd89ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 3614,
"upload_time": "2023-10-30T22:54:17",
"upload_time_iso_8601": "2023-10-30T22:54:17.764064Z",
"url": "https://files.pythonhosted.org/packages/f1/a5/eeeb6d10211af2bb1a1dc67d4d9dcabb8e4d19d1d6a65a150e18c6e8261d/pygments_pre_commit-2.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-30 22:54:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "asottile",
"github_project": "pygments-pre-commit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pygments-pre-commit"
}