<commit_before>=======================
 Developing Hieroglyph
=======================

Hieroglyph uses Buildout_ to manage dependencies and development.

#. Check out the repository::

   $ git clone <EMAIL>:nyergler/hieroglyph.git

#. Bootstrap and run buildout::

   $ python bootstrap.py
   $ ./bin/buildout

After running Buildout, you can run ``./bin/python`` to execute an
interpreter with Hieroglyph and its dependencies installed.

Running Tests
=============

The unit tests can be run via ``setup.py``::

  $ ./bin/python setup.py test

Tox_ can be used to run the tests with both Python 2.7 and 3.3. The
Tox configuration will run the tests with Sphinx 1.1.3, Sphinx 1.2,
and the development branch.

.. _Buildout: https://pypi.python.org/pypi/zc.buildout/2.2.1
.. _Tox: http://tox.readthedocs.org/en/latest/<commit_msg>Added docs on running Jasmine tests. (#61)<commit_after>=======================
 Developing Hieroglyph
=======================

Hieroglyph uses Buildout_ to manage dependencies and development.

#. Check out the repository::

   $ git clone <EMAIL>:nyergler/hieroglyph.git

#. Bootstrap and run buildout::

   $ python bootstrap.py
   $ ./bin/buildout

After running Buildout, you can run ``./bin/python`` to execute an
interpreter with Hieroglyph and its dependencies installed.

Running Tests
=============

The unit tests can be run via ``setup.py``::

  $ ./bin/python setup.py test

Tox_ can be used to run the tests with both Python 2.7 and 3.3. The
Tox configuration will run the tests with Sphinx 1.1.3, Sphinx 1.2,
and the development branch.

Jasmine Tests for Javascript
----------------------------

There are some Jasmine_ tests in ``src/jstests`` that test theme
Javascript functionality. You can open ``src/jstests/SpecRunner.html``
in your browser to run those. Alternately, you can install the
``jasmine`` gem to do so.

If you have Bundler_ installed, get started by installing the
necessary gems::

  $ bundle install

Then run the tests using ``rake``::

  $ rake jasmine:ci JASMINE_CONFIG_PATH=./src/jstests/jasmine.yml

.. _Buildout: https://pypi.python.org/pypi/zc.buildout/2.2.1
.. _Tox: http://tox.readthedocs.org/en/latest/
.. _Jasmine: http://jasmine.github.io/
.. _Bundler: http://bundler.io/
{'fraction_non_alphanumeric': 0.16126166148378498, 'fraction_numerical': 0.011550422034651266, 'mean_word_length': 3.7610993657505287, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1832206', 'n_tokens_mistral': 743, 'n_tokens_neox': 681, 'n_words': 246}