Metadata-Version: 2.4
Name: vre-language-pygments
Version: 0.0.1
Summary: Pygments plugin for VRE-Language
Project-URL: Homepage, https://gitlab.kit.edu/kit/virtmat-tools/vre-language-pygments
Project-URL: Download, https://pypi.org/project/vre-language-pygments/#files
Project-URL: Issues, https://gitlab.kit.edu/kit/virtmat-tools/vre-language-pygments/-/issues
Author-email: The Virtmat Tools Team <virtmat-tools@lists.kit.edu>
License-Expression: BSD-3-Clause
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Requires-Dist: pygments
Description-Content-Type: text/markdown

# pygments-plugin-texts

This is a plugin for the [Pygments package](https://pygments.org/) providing
a lexer, formatter, filter and style for the
[VRE-Language](https://gitlab.kit.edu/kit/virtmat-tools/vre-language)
family of languages (currently textS and textM).

## Run the lexer

Via CLI:
```bash
pygmentize -l texts test.vm
```
The lexer class can be imported directly using
```python
from texts_lexer import TextSLexer
```

## Run the formatter

Via CLI:
```bash
pygmentize -f texts-format test.vm
```

Retrieve the formatter class via the API with
```python
formatter_class = pygments.formatters.find_formatter_class("texts-format")
```

## Run the style

Via CLI:
```bash
pygmentize -O style=texts-style
```

Retrieve the style class via API with
```python
style_class = pygments.styles.get_style_by_name('texts-style')
```

## Run the filter

Via CLI:
```bash
pygmentize -F texts-filter
```
Retrieve the filter class via API with
```python
filter_class = pygments.filters.find_filter_class('texts-filter')
```

## Run the tests

After installing the plugin, the tests can be run by these commands:

```bash
pygmentize -l textm test_1.vm
pygmentize -l textm test_2.vm
```
