<commit_before>Installation
============

Install using pip::

	pip install -U gargoyle

Or alternatively, easy_install::

	easy_install -U gargoyle

Enable Gargoyle
---------------

Once you've downloaded the Gargoyle package, you simply need to add it to your ``INSTALLED_APPS``::

	INSTALLED_APPS = (
	    ...
	    'gargoyle',
	)

*If you do not use Nexus*, you will also need to enable discovery of ``gargoyle.py`` modules (which contain ConditionSets).
The best place to do this is within your ``urls.py`` file.

	>>> import gargoyle
	>>> gargoyle.autodiscover()

Nexus Frontend
--------------

While Gargoyle can be used without a frontend, we highly recommend using `Nexus <https://github.com/dcramer/nexus>`_.<commit_msg>Note about autodiscovery behavior<commit_after>Installation
============

Install using pip::

	pip install -U gargoyle

Or alternatively, easy_install::

	easy_install -U gargoyle

Enable Gargoyle
---------------

Once you've downloaded the Gargoyle package, you simply need to add it to your ``INSTALLED_APPS``::

	INSTALLED_APPS = (
	    ...
	    'gargoyle',
	)

*If you do not use Nexus*, you will also need to enable discovery of ``gargoyle.py`` modules (which contain ConditionSets).
The best place to do this is within your ``urls.py`` file.

	>>> import gargoyle
	>>> gargoyle.autodiscover()

If you do use ``gargoyle.py`` files and the autodiscovery code, you'll need to ensure your imports are not relative::

  from __future__ import absolute_import

  from gargoyle.conditions import ConditionSet
  # ...

Nexus Frontend
--------------

While Gargoyle can be used without a frontend, we highly recommend using `Nexus <https://github.com/dcramer/nexus>`_.
{'fraction_non_alphanumeric': 0.13333333333333333, 'fraction_numerical': 0.0, 'mean_word_length': 3.5714285714285716, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 17, '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': '3356714', 'n_tokens_mistral': 536, 'n_tokens_neox': 500, 'n_words': 193}