.. _ru_start:

Быстрый старт
=============

Для получения исходного кода OutWiker вам понадобится git_. Также должны быть установлены Python 3.5 или 3.6 и pip_. Рекомендуется Python 3.6.

0. Если вы работаете под Linux, то убедитесь, что у вас установлены следующие пакеты:


.. literalinclude:: requirements_linux.txt
    :language: text


Данный список составлен на основе имен пакетов в дистрибутиве Ubuntu. В других дистрибутивах имена пакетов могут отличаться.

Данные пакеты требуются для успешной компиляции wxPython_ при установке зависимостей (требуется wxPython 4.0.x). Более подробно о требуемых зависимостях для wxPython смотрите `здесь <https://github.com/wxWidgets/Phoenix#prerequisites>`_. Также в этот список включены пакеты, необходимые для сборки deb-пакетов под Linux.

1. Чтобы получить исходный код OutWiker выполните в консоли команду:

.. code:: bash

    git clone https://github.com/Jenyay/outwiker

Эта команда создаст папку с именем :file:`outwiker` в текущей папке, в которую будут скачены исходные коды программы OutWiker.

2. Зайдите в эту папку с помощью команды

.. code:: bash

    cd outwiker

3. Для указания зависимостей в OutWiker используется Pipfile_, для работы с которым удобнее всего использовать pipenv_, который будет автоматически создавать виртуальное окружение (virtualenv) для данного проекта.  Устанавливается pipenv_ с помощью команды

.. code:: bash

    pip install pipenv


4. Установите требуемые библиотеки с помощью команд:

.. code:: bash

    pipenv update --dev


В данной команде параметр `--dev` указывает на то, что кроме минимально необходимого набора библиотек необходимо установить библиотеки, используемые при разработке, но которые не требуются для запуска OutWiker из исходников.

Под Linux установка требуемых бибилиотек может занять достаточно долгое время (больше получаса), т.к. в этот момент происходит компиляция библиотеки wxPython_. Под Windows установка библиотек происходит достаточно быстро, т.к. компиляция не требуется.


5. Теперь можно запустить виртуальное окружение со всеми необходимыми библиотеками

.. code:: bash

    pipenv shell


6. Если все установилось без ошибок, то следующая команда должна запустить программу OutWiker:

.. code:: bash

    fab run

7. Также можно запустить тесты (выполнение тестов может занять несколько минут, а под Windows в несколько раз больше времени):

.. code:: bash

    fab test


.. _git: https://git-scm.com/
.. _pip: https://pip.pypa.io/en/stable/
.. _wxPython: https://wxpython.org/
.. _Pipfile: https://github.com/pypa/pipfile/
.. _pipenv: https://docs.pipenv.org/