.. _installation_development:

Development Environment
=======================

.. _installation_development_packages:

Installing Required Packages
----------------------------

Before installing `CioWarehouse`, you must have on your system the following
packages:

.. code-block:: bash

    $ sudo aptitude install git imagemagick wkhtmltopdf inkscape poppler-utils


Installing the Module
----------------------

Installation in Standard Mode
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Install the latest stable released and all its requirements into your virtual
Python environment:

.. code-block:: bash

    $ source ~/bin/virtualenv3/bin/activate
    (virtualenv3)$ pip install --extra-index-url=https://pypi.chrysal.io CioWarehouse

Create a directory to deploy your instance and retrieve an example of
configuration files:

.. code-block:: bash

    $ wget https://pypi.chrysal.io/conf/CioWarehouse.zip
    $ unzip CioWarehouse.zip
    $ rm -f CioWarehouse.zip

You could update your installation with the following command:

.. code-block:: bash

    (virtualenv3)$ pip install --extra-index-url=https://pypi.chrysal.io -U Chrysalio CioWarehouse

Now, you can activate your module by adding in your ``development.ini`` the
following options:

.. code-block:: ini

    [app:main]
    chrysalio.includes =
        chrysalio.menu,
        chrysalio.includes.cache,
        chrysalio.includes.modules,
        ciowarehouse

    [CioWarehouse]
    locations =
        private:%(here)s/__Warehouses/Private,
        local:%(here)s/__Warehouses/Local,
        remote:%(here)s/__Warehouses/Remote,
        no-vcs:%(here)s/__Warehouses/NoVcs
    handlers.root = %(here)s/__Var/Handlers
    handlers.develop = true
    restful.key = ciosekreet
    restful.token_ttl = 1.0

Installation in Development Mode
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you want to use the release still in development, follow these steps:

.. code-block:: bash

    $ mkdir ~/Repositories
    $ cd ~/Repositories
    $ git clone https://gitlab.iinov.com/chrysalio/CioWarehouse.git
    $ source ~/bin/virtualenv3/bin/activate
    (virtualenv3)$ cd CioWarehouse
    (virtualenv3)$ pip install -e ".[development]"