gwift-book/source/intro/01-prerequisites.rst

*************
Environnement
*************

Avant de démarrer le développement, il est nécessaire de passer un peu de temps sur la configuration de l'environnement.

Les morceaux de code seront développés pour Python3.4+ et Django 1.8+. Ils nécessiteront peut-être quelques adaptations pour fonctionner sur une version antérieure.

**Remarque** : les commandes qui seront exécutés dans ce livre le seront depuis un shell sous GNU/Linux. Certaines devront donc être adaptées si vous êtes dans un autre environnemnet.

Virtualenv
==========

Nous allons utiliser ``virtualenv`` afin de créer un `environnement virtuel <http://sametmax.com/les-environnement-virtuels-python-virtualenv-et-virtualenvwrapper/>`_ pour python et ``virtualenvwrapper`` pour en faciliter la gestion, et les prérequis seront remplis.

Suivant votre distribution, il sera sans doute nécessaire d'éditer le fichier ``~/.bashrc`` (ou tout fichier lancé au démarrage de votre session) et de vérifier que la variable ``WORKON_HOME`` est bien définie et de faire un ``source`` sur le fichier ``virtualenvwrapper.sh`` (à adapter en fonction de votre distribution):

.. code-block:: shell

    # ~/.bashrc

    [...]

    WORKON_HOME=~/.virtualenvs
    source /usr/local/bin/virtualenvwrapper.sh

L'intérêt de ceci ? Ne pas devoir se soucier de l'emplacement des environnements virtuels, et pouvoir entièrement les découpler des sources sur lesquelles vous travaillez, en plus d'isoler le code, de créer un containeur pour les dépendances et d'être indépendant des librairies tierces déjà installées sur le système.

Création de l'environnement virtuel
===================================

Commencons par créer un environnement virtuel, afin d'y stocker les dépendances. Lancez ``mkvirtualenv gwift-env``.

.. code-block:: shell

    $ mkvirtualenv -p python3 gwift-env
    New python executable in gwift-env/bin/python3
    Also creating executable in gwift-env/bin/python
    Installing setuptools, pip...done.

Ceci créera l'arborescence de fichiers suivante, qui peut à nouveau être un peu différente en fonction du système d'exploitation:

.. code-block:: shell

    $ ls .virtualenvs/gwift-env
    bin include lib

Nous pouvons ensuite l'activer grâce à la commande ``workon gwift-env``.

.. code-block:: shell

    $ workon gwift-env
    (gwift-env)$ which python
    (gwift-env)$ /home/jaguarondi/.virtualenv/gwift-env/bin/python

Le *shell* signale que nous sommes bien dans l'environnement ``gwift-env`` en l'affichant avant le ``$``. Par la suite, nous considérerons que l'environnement virtuel est toujours activé, même si ``gwift-env`` n'est pas présent devant chaque ``$``.

A présent, tous les binaires de cet environnement prendront le pas sur les binaires du système. De la même manière, une variable ``PATH`` propre est définie et utilisée, afin que les librairies Python y soient stockées. C'est donc dans cet environnement virtuel que nous retrouverons le code source de Django, ainsi que des librairies externes pour Python une fois que nous les aurons installées.

Pour désactiver l'environnement virtuel, il suffira d'utiliser la commande ``deactivate``

Création du répertoire de travail
=================================

Nous commençons par créer le répertoire du projet, à savoir ``gwift-project``.

.. code-block:: shell

    $ mkdir gwift-project
    $ cd gwift-project

Dans ce répertoire, nous pouvons rajouter les répertoires utiles à la gestion d'un projet:

.. code-block:: shell

    $ mkdir docs requirements
    $ touch docs/README.md

Création du projet Django
=========================

Comme l'environnement est activé, on peut à présent y installer Django. La librairie restera indépendante du reste du système, et ne polluera pas les autres projets.

C'est parti: ``pip install django``!

.. code-block:: shell

    $ pip install django
    Collecting django
      Downloading Django-1.8.4-py2.py3-none-any.whl (6.2MB)
    100% |################################| 6.2MB 91kB/s  eta 0:00:01
    Installing collected packages: django
    Successfully installed django-1.8.4

Les commandes de création d'un nouveau site sont à présent disponibles, la principale étant ``django-admin startproject``. Par la suite, nous utiliserons ``manage.py``, qui constitue un *wrapper* autour de `django-admin`.

Pour démarrer notre projet, nous lançons donc ``django-admin startproject gwift``.

.. code-block:: shell

    $ django-admin startproject gwift

Cette action a pour effet de créer un nouveau dossier ``gwift``, dans lequel on trouve la structure suivante:

.. code-block:: shell

    $ tree gwift
    gwift
    ├── gwift
    │   ├── __init__.py
    │   ├── settings.py
    │   ├── urls.py
    │   └── wsgi.py
    └── manage.py

Si vous le souhaitez, et pour plus de clarté, renommez le premier dossier ``gwift`` en ``src``, par exemple: cela évitera d'avoir une structure hiérarchique type ``gwift-project/gwift/gwift``, mais plutôt quelque chose comme ``gwift-project/src/gwift``, sur le modèle ``{projet}/{sources}/{application}``. On a à présent:

.. code-block:: shell

    $ tree src
    src
    ├── gwift
    │   ├── __init__.py
    │   ├── settings.py
    │   ├── urls.py
    │   └── wsgi.py
    └── manage.py


Chacun de ces fichiers sert à:

 * ``settings.py`` contient tous les paramètres globaux à notre projet.
 * ``urls.py`` contient les variables de routes, les adresses utilisées et les fonctions vers lesquelles elles pointent.
 * ``manage.py``, pour toutes les commandes de gestion.
 * ``wsgi.py`` contient la définition de l'interface `WSGI <https://en.wikipedia.org/wiki/Web_Server_Gateway_Interface>`_, qui permettra à votre serveur Web (Nginx, Apache, ...) de faire un pont vers votre projet.

Gestion des dépendances
=======================

Comme nous venons d'ajouter une dépendance à notre projet, nous allons créer un fichier reprenant tous les dépendances de notre projet. Celles-ci sont normalement placées dans un fichier ``requirements.txt``. Dans un premier temps, ce fichier peut être placé directement à la racine du projet, mais on préférera rapidement le déplacer dans un sous-répertoire spécifique (``requirements``), afin de grouper les dépendances en fonction de leur utilité:

 * ``base.txt``
 * ``dev.txt``
 * ``staging.txt``
 * ``production.txt``

Au début de chaque fichier, il suffira d'ajouter la ligne ``-r base.txt``, puis de lancer l'installation grâce à un ``pip install -r <nom du fichier>``. De cette manière, il est tout à fait acceptable de n'installer `flake8` et `django-debug-toolbar` qu'en développement par exemple.  Dans l'immédiat, ajoutez simplement ``django`` dans le fichier ``requirements/base.txt``.

.. code-block:: shell

    $ echo django >> requirements/base.txt

Structure finale de l'environnement
===================================

Nous avons donc la strucutre finale pour notre environnement de travail:

.. code-block:: shell

    $ tree ~/gwift-project
    gwift-project/
    ├── docs
    │   └── README.md
    ├── src
    │   ├── gwift
    │   │   ├── __init__.py
    │   │   ├── settings.py
    │   │   ├── urls.py
    │   │   └── wsgi.py
    │   └── manage.py
    └── requirements
        └── base.txt