.. _install:

Установка
=========

Пакет m3-kladr подключается как приложение M3.

Для функционирования, также требуется установка дополнительных библиотек.

Необходимые библиотеки
----------------------

* dbfpy==2.2.5
* m3-core>=2.0
* m3-ext3>=2.0

Установка с помощью pip
-----------------------

Установите пакет ``m3-kladr`` из репозитория пакетов компании ``БАРС Груп``

::

    pip install m3-kladr -i https://<PyPI_сервер_БАРС_Груп>

В этом случае будут установлены все необходимые пакеты.

Теперь можно приступать к `настройке M3-приложения`__.

__ Настройка_

Установка из архива
-------------------

Скачайте и распакуйте архив модуля
https://bitbucket.org/barsgroup/m3-kladr/downloads


Установка из Mercurial
----------------------

Клонируйте исходный код модуля из репозитория

::

    hg clone https://bitbucket.org/barsgroup/m3-kladr


Установка из каталога
---------------------

Установка
::

    python setup.py install


Настройка
---------

Подключение пакета осуществляется в файле ``settings.py`` приложения.
Необходимо добавить имя пакета в раздел ``INSTALLED_APPS``.

::

    INSTALLED_APPS = (
        kladr,
    )

Также необходимо добавить таблицы в СУБД. Если в Вашем проекте
используется модуль `South`_ запустите команду:

::

    python manage.py migrate kladr

В противном случае запустите команду:

::

    python manage.py syncdb

.. _South: http://south.aeracode.org/