<commit_before>CindyScriptPygments
===================

|PyPi version badge| |Supported Python versions|

.. |PyPi version badge| image:: https://img.shields.io/pypi/v/CindyScriptPygments.svg
   :target: https://pypi.python.org/pypi/CindyScriptPygments/
.. |Supported Python versions| image:: https://img.shields.io/pypi/pyversions/CindyScriptPygments.svg

Pygments_ plugin for the CindyScript_ language
used by Cinderella_ and CindyJS_.
It can be used to nicely format CindyScript as HTML or in other formats.

Installation
------------

In theory, all you need to do is install ``Pygments`` and this package here:

.. code:: sh

    pip install Pygments
    pip install CindyScriptPygments

This will install the latest release of each of these packages.
(Some future version of the package will likely mention ``Pygments`` as a dependency.)
If you don’t want to install the package system-wide, ``pip`` offers alternatives
like the ``--user`` flag for a per-user installation.
See ``pip install --help`` for details.
In that case, you may have to perform additional steps in order to ensure
that the ``pygmentize`` command line utility is available on the ``PATH``.

Usage
-----

This plugin registers a Pygments lexer for a language named ``CindyScript``,
associated with the MIME type ``text/x-cindyscript``.
You can use it from the command line like this:

.. code:: sh

    pygmentize -l cindyscript sourcecode.cs

To generate specific file formats, use commands like these:

.. code:: sh

    pygmentize -f html -O full -l cindyscript -o sourcecode.html sourcecode.cs
    pygmentize -f tex -O full -l cindyscript -o sourcecode.tex sourcecode.cs
    pygmentize -f svg -O full -l cindyscript -o sourcecode.svg sourcecode.cs

The file extension ``*.cs`` is not associated with the plugin,
since that’s already taken by C# a.k.a. ``csharp``.<commit_msg>Adjust documentation for automatic dependency on Pygments<commit_after>CindyScriptPygments
===================

|PyPi version badge| |Supported Python versions|

.. |PyPi version badge| image:: https://img.shields.io/pypi/v/CindyScriptPygments.svg
   :target: https://pypi.python.org/pypi/CindyScriptPygments/
.. |Supported Python versions| image:: https://img.shields.io/pypi/pyversions/CindyScriptPygments.svg

Pygments_ plugin for the CindyScript_ language
used by Cinderella_ and CindyJS_.
It can be used to nicely format CindyScript as HTML or in other formats.

Installation
------------

In theory, all you need to do is install ``Pygments`` and this package here:

.. code:: sh

    pip install CindyScriptPygments

This will install the latest release of each of these packages.
If you don’t want to install the package system-wide, ``pip`` offers alternatives
like the ``--user`` flag for a per-user installation.
See ``pip install --help`` for details.
In that case, you may have to perform additional steps in order to ensure
that the ``pygmentize`` command line utility is available on the ``PATH``,
at least if the ``Pygments`` dependency isn’t already installed globally.

Usage
-----

This plugin registers a Pygments lexer for a language named ``CindyScript``,
associated with the MIME type ``text/x-cindyscript``.
You can use it from the command line like this:

.. code:: sh

    pygmentize -l cindyscript sourcecode.cs

To generate specific file formats, use commands like these:

.. code:: sh

    pygmentize -f html -O full -l cindyscript -o sourcecode.html sourcecode.cs
    pygmentize -f tex -O full -l cindyscript -o sourcecode.tex sourcecode.cs
    pygmentize -f svg -O full -l cindyscript -o sourcecode.svg sourcecode.cs

The file extension ``*.cs`` is not associated with the plugin,
since that’s already taken by C# a.k.a. ``csharp``.
{'fraction_non_alphanumeric': 0.10456989247311828, 'fraction_numerical': 0.0, 'mean_word_length': 3.9745989304812834, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7404310', 'n_tokens_mistral': 1149, 'n_tokens_neox': 1080, 'n_words': 469}