<commit_before>.. _installation:

============
Installation
============

Dependencies
------------

You must install the following packages to use Authentic

- Python Lasso binding 2.3.6:

   From sources: http://lasso.entrouvert.org/download
   Debian based distribution: apt-get install python-lasso

- Django 1.3:

   From sources: http://www.djangoproject.com/download/1.3/tarball/

- Django-registration 0.8-alpha-1:

    From sources: http://bitbucket.org/ubernostrum/django-registration/downloads
    Debian based distribution: apt-get install python-django-registration

- Django-authopenid 0.9.6:

   From sources: http://bitbucket.org/benoitc/django-authopenid/downloads

- Django-south 0.7.3:

   From sources:: http://south.aeracode.org/docs/installation.html

- Django-profiles 0.2:

   From sources:: http://pypi.python.org/pypi/django-profiles

You install all the django libraries quickly using pip::

   pip install django django-profiles django-registration \
               django-debug-toolbar django-authopenid south

or easy_install::

   easy_install django django-profiles django-registration \
                django-debug-toolbar django-authopenid south

Quick Start
-----------

Then launch the following commands::

  python manage.py syncdb --migrate
  python manage.py runserver

You should see the following output::

  Validating models...
  0 errors found

  Django version 1.2, using settings 'authentic.settings'
  Development server is running at http://127.0.0.1:8000/
  Quit the server with CONTROL-C.

  You can access the running application on http://127.0.0.1:8000/


Specifying a different database
-------------------------------

This is done by modifying the DATABASES dictionary in your local_settings.py file
(create it in Authentic project directory); for example::

 DATABASES['default'] = {
   'ENGINE': 'django.db.backends.postgresql',
   'NAME': 'authentic',
   'USER': 'admindb',
   'PASSWORD': '<PASSWORD>',
   'HOST': 'db.example.com',
   'PORT': '', # empty string means default value
 }

You should refer to the Django documentation on databases settings at
http://docs.djangoproject.com/en/dev/ref/settings/#databases for all
the details.

How to upgrade to a new version of authentic ?
----------------------------------------------

Authentic store all its data in a relational database as specified in its
settings.py or local_settings.py file. So in order to upgrade to a new version
of authentic you have to update your database schema using the
migration command — you will need to have installed the dependency django-south,
see the beginning of this README file.::

  python ./manage.py migrate

Then you will need to create new tables if there are.::

  python ./manage.py syncdb
<commit_msg>[doc] Missing installation instruction.<commit_after>.. _installation:

============
Installation
============

Dependencies
------------

You must install the following packages to use Authentic

- Python Lasso binding 2.3.6:

   From sources: http://lasso.entrouvert.org/download
   Debian based distribution: apt-get install python-lasso

- Django 1.3:

   From sources: http://www.djangoproject.com/download/1.3/tarball/

- Django-registration 0.8-alpha-1:

    From sources: http://bitbucket.org/ubernostrum/django-registration/downloads
    Debian based distribution: apt-get install python-django-registration

- Django-authopenid 0.9.6:

   From sources: http://bitbucket.org/benoitc/django-authopenid/downloads

- Django-south 0.7.3:

   From sources:: http://south.aeracode.org/docs/installation.html

- Django-profiles 0.2:

   From sources:: http://pypi.python.org/pypi/django-profiles

You install all the django libraries quickly using pip::

   pip install django django-profiles django-registration \
               django-debug-toolbar django-authopenid south

or easy_install::

   easy_install django django-profiles django-registration \
                django-debug-toolbar django-authopenid south

Quick Start
-----------

Then launch the following commands::

  python manage.py syncdb --migrate
  python manage.py collectstatic
  python manage.py runserver

You should see the following output::

  Validating models...
  0 errors found

  Django version 1.2, using settings 'authentic.settings'
  Development server is running at http://127.0.0.1:8000/
  Quit the server with CONTROL-C.

  You can access the running application on http://127.0.0.1:8000/


Specifying a different database
-------------------------------

This is done by modifying the DATABASES dictionary in your local_settings.py file
(create it in Authentic project directory); for example::

 DATABASES['default'] = {
   'ENGINE': 'django.db.backends.postgresql',
   'NAME': 'authentic',
   'USER': 'admindb',
   'PASSWORD': '<PASSWORD>',
   'HOST': 'db.example.com',
   'PORT': '', # empty string means default value
 }

You should refer to the Django documentation on databases settings at
http://docs.djangoproject.com/en/dev/ref/settings/#databases for all
the details.

How to upgrade to a new version of authentic ?
----------------------------------------------

Authentic store all its data in a relational database as specified in its
settings.py or local_settings.py file. So in order to upgrade to a new version
of authentic you have to update your database schema using the
migration command — you will need to have installed the dependency django-south,
see the beginning of this README file.::

  python ./manage.py migrate

Then you will need to create new tables if there are.::

  python ./manage.py syncdb

{'fraction_non_alphanumeric': 0.12900913814728543, 'fraction_numerical': 0.014692707400107507, 'mean_word_length': 3.1687826736370424, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 4, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 10, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3907419', 'n_tokens_mistral': 1661, 'n_tokens_neox': 1530, 'n_words': 550}