<commit_before>=============================
signbank-dictionary
=============================

.. image:: https://badge.fury.io/py/signbank-dictionary.png
    :target: https://badge.fury.io/py/signbank-dictionary

.. image:: https://travis-ci.org/hujosh/signbank-dictionary.png?branch=master
    :target: https://travis-ci.org/hujosh/signbank-dictionary
    
.. image:: https://codecov.io/gh/hujosh/signbank-dictionary/branch/master/graph/badge.svg
  :target: https://codecov.io/gh/hujosh/signbank-dictionary

The dictionary component of Signbank

Documentation
-------------

The full documentation is at https://signbank-dictionary.readthedocs.org.

Quickstart
----------

Install signbank-dictionary::

    pip install signbank-dictionary

Then use it in a project::

    import dictionary
    
You must define the following variables in ``settings.py``

* ``ALWAYS_REQUIRE_LOGIN``
* ``LANGUAGE_NAME``
* ``ANON_TAG_SEARCH``
* ``ANON_SAFE_SEARCH`` 

You must also add ``dictionary``, and ``tagging`` to your ``INSTALLED_APPS`` variable.


Features
--------

* TODO

Running Tests
--------------

Does the code actually work?

::

    source <YOURVIRTUALENV>/bin/activate
    (myenv) $ pip install -r requirements_test.txt
    (myenv) $ python runtests.py
<commit_msg>Added more variables and explanations<commit_after>=============================
signbank-dictionary
=============================

.. image:: https://badge.fury.io/py/signbank-dictionary.png
    :target: https://badge.fury.io/py/signbank-dictionary

.. image:: https://travis-ci.org/hujosh/signbank-dictionary.png?branch=master
    :target: https://travis-ci.org/hujosh/signbank-dictionary
    
.. image:: https://codecov.io/gh/hujosh/signbank-dictionary/branch/master/graph/badge.svg
  :target: https://codecov.io/gh/hujosh/signbank-dictionary

The dictionary component of Signbank

Documentation
-------------

The full documentation is at https://signbank-dictionary.readthedocs.org.

Quickstart
----------

Install signbank-dictionary::

    pip install signbank-dictionary

Then use it in a project::

    import dictionary
    
You must define the following variables in ``settings.py``

* ``ALWAYS_REQUIRE_LOGIN`` 
* ``LANGUAGE_NAME``
* ``ANON_TAG_SEARCH``
* ``ANON_SAFE_SEARCH`` 
* ``FORCE_LOWERCASE_TAGS``
* ``ALLOWED_TAGS``

``AllOWED_TAGS`` is a list of strings. The variable is used by the ``tagging`` app.
You can copy and paste the following list when you come to defining ``ALLOWED_TAGS`` in
your ``settings.py`` ::
    
    ALLOWED_TAGS = [ '', 
                 'b92:directional',
                 'b92:regional',
                 'corpus:attested',
                 'iconicity:obscure',
                 'iconicity:opaque',
                 'iconicity:translucent',
                 'iconicity:transparent',
                 'lexis:battinson',
                 'lexis:classifier',
                 'lexis:crude',
                 'lexis:doubtlex',
                 'lexis:fingerspell',
                 'lexis:gensign',
                 'lexis:marginal',
                 'lexis:obsolete',
                 'lexis:proper name',
                 'lexis:regional',
                 'lexis:restricted lexeme',
                 'lexis:signed english',
                 'lexis:signed english only',
                 'lexis:technical',
                 'lexis:varlex',
                 'morph:begin directional sign',
                 'morph:body locating',
                 'morph:directional sign',
                 'morph:end directional sign',
                 'morph:locational and directional',
                 'morph:orientating sign',
                 'phonology:alternating',
                 'phonology:dominant hand only',
                 'phonology:double handed',
                 'phonology:forearm rotation',
                 'phonology:handshape change',
                 'phonology:onehand',
                 'phonology:parallel',
                 'phonology:symmetrical',
                 'phonology:two handed',
                 'religion:anglican',
                 'religion:catholic',
                 'religion:catholic school',
                 'religion:jehovas witness',
                 'religion:other',
                 'religion:religion',
                 'semantic:animal',
                 'semantic:arithmetic',
                 'semantic:arts',
                 'semantic:bodypart',
                 'semantic:car',
                 'semantic:city',
                 'semantic:clothing',
                 'semantic:color',
                 'semantic:cooking',
                 'semantic:day',
                 'semantic:deaf',
                 'semantic:drink',
                 'semantic:education',
                 'semantic:family',
                 'semantic:feel',
                 'semantic:food',
                 'semantic:furniture',
                 'semantic:government',
                 'semantic:groom',
                 'semantic:health',
                 'semantic:judge',
                 'semantic:language act',
                 'semantic:law',
                 'semantic:material',
                 'semantic:metalg',
                 'semantic:mind',
                 'semantic:money',
                 'semantic:nature',
                 'semantic:number',
                 'semantic:order',
                 'semantic:people',
                 'semantic:physical act',
                 'semantic:quality',
                 'semantic:quantity',
                 'semantic:question',
                 'semantic:recreation',
                 'semantic:rooms',
                 'semantic:salutation',
                 'semantic:sensing',
                 'semantic:sexuality',
                 'semantic:shapes',
                 'semantic:shopping',
                 'semantic:sport',
                 'semantic:telecommunications',
                 'semantic:time',
                 'semantic:travel',
                 'semantic:utensil',
                 'semantic:weather',
                 'semantic:work',
                 'school:state school',
                 'workflow:needs video',
                 'workflow:redo video',
                 'workflow:problematic',
                 ]

You must also add ``dictionary``, and ``tagging`` to your ``INSTALLED_APPS`` variable.


Features
--------

* TODO

Running Tests
--------------

Does the code actually work?

::

    source <YOURVIRTUALENV>/bin/activate
    (myenv) $ pip install -r requirements_test.txt
    (myenv) $ python runtests.py

{'fraction_non_alphanumeric': 0.1411530815109344, 'fraction_numerical': 0.0006117143294081664, 'mean_word_length': 1.746745065098698, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 14, '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': '5763658', 'n_tokens_mistral': 1848, 'n_tokens_neox': 1751, 'n_words': 325}