<commit_before>How to contribute
=================

This section needs to be filled. For now, see the `CONTRIBUTING.md
<https://github.com/JelteF/PyLaTeX/blob/master/CONTRIBUTING.md>`_ file in the
git repository.
<commit_msg>Added documentation on how to use the provided Vagrantfile.<commit_after>How to contribute
=================

This section needs to be filled. For now, see the `CONTRIBUTING.md
<https://github.com/JelteF/PyLaTeX/blob/master/CONTRIBUTING.md>`_ file in the
git repository.

Vagrant support
---------------
If you don't want to manually setup a suitable development environment in
order to contribute, PyLaTeX comes with a ready-made Vagrantfile. Vagrant
will launch and configure a small virtual machine with all necessary
tools for you, so that you can start working with PyLaTeX right away.

With Vagrant already installed, you can start the virtual machine with
``$ vagrant up`` and then use ``$ vagrant ssh`` to ssh into it. Your source
files will be located under ``/vagrant``.
To run all unit tests and build the documentation run
``$ ./testall.sh -p python3 -c`` from that directory.

You can download or read more about Vagrant on https://www.vagrantup.com/.
{'fraction_non_alphanumeric': 0.11269974768713205, 'fraction_numerical': 0.0008410428931875525, 'mean_word_length': 4.36036036036036, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 3, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2239860', 'n_tokens_mistral': 342, 'n_tokens_neox': 328, 'n_words': 153}