https://github.com/pygments/pygments-plugin-scaffolding
Boilerplate for writing Pygments plugins
https://github.com/pygments/pygments-plugin-scaffolding
Last synced: 10 months ago
JSON representation
Boilerplate for writing Pygments plugins
- Host: GitHub
- URL: https://github.com/pygments/pygments-plugin-scaffolding
- Owner: pygments
- Created: 2023-11-05T18:31:51.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-26T14:47:41.000Z (about 2 years ago)
- Last Synced: 2025-04-09T10:16:14.268Z (11 months ago)
- Size: 3.91 KB
- Stars: 6
- Watchers: 1
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pygments plugin examples
This repository contains an example of the project scaffolding needed to write a
plugin lexer/formatter/style/filter for the [Pygments](https://pygments.org)
syntax highlighter.
Roadmap:
```
.
├── example_filter.py # An example filter
├── example_formatter.py # An example formatter
├── example_lexer.py # An example lexer
├── example_style.py # An example style
├── pyproject.toml # The Python package metadata file
├── README.md # You are here
└── test.exmpl # A test file in the mockup language of the example lexer
```
To be usable, plugins must be installed. If you are running the `pygmentize`
command, you probably want to use a
[virtual environment](https://docs.python.org/3/library/venv.html)
to avoid installing packages globally. For example, here is how to create
a virtual environment and install this set of plugins into it:
```
python -m venv venv/
venv/bin/pip install . # install the project in current directory into the virtual environment
venv/bin/pygmentize ... # use the pygmentize command from the virtual environment
```
Alternatively, since this example uses the [Hatch](https://hatch.pypa.io)
tool, you may use
```
hatch run pygmentize ...
```
If you are using Pygments from Python, possibly through a tool like Sphinx,
mkdocs, etc., then you just need to install the plugin in the same environment
as the one where you installed Pygments.
If you want to distribute your plugin on PyPI, you should read the
[packaging user guide](https://packaging.python.org/en/latest/tutorials/packaging-projects).
#### License for this template
There isn't much copyrightable content here, but if you are worried about reuse:
Copyright (C) 2023 by Jean Abou Samra
Permission to use, copy, modify, and/or distribute this software for any purpose
with or without fee is hereby granted.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
THIS SOFTWARE.