126 lines
5.9 KiB
ReStructuredText
126 lines
5.9 KiB
ReStructuredText
*************
|
|
Environnement
|
|
*************
|
|
|
|
Avant de démarrer le développement, il est nécessaire de passer un peu de temps sur la configuration de l'environnement.
|
|
|
|
Nous allons utiliser `Python <https://www.python.org/>`_, disponible sur la majorité des distributions GNU/Linux, ainsi que sur MacOS, dans des versions parfois différentes. Pour les utilisateurs de Windows, il sera sans doute nécessaire d'installer une version de l'interpréteur et de configurer la variable *PATH* pour votre utilisateur. Ajoutez-y ``virtualenv`` afin de créer un `environnement virtuel <http://sametmax.com/les-environnement-virtuels-python-virtualenv-et-virtualenvwrapper/>`_, puis ``virtualenvwrapper`` pour en faciliter la gestion, et les prérequis seront remplis.
|
|
|
|
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 devrons donc être adaptées si vous êtes dans un autre environnemnet.
|
|
|
|
Création de l'environnement
|
|
===========================
|
|
|
|
Commencez par créer un environnement virtuel, afin d'y stocker les dépendances. Vérifiez dans votre fichier `~/.bashrc` (ou tout fichier lancé au démarrage de votre session) que la variable `WORKON_HOME` est bien définie. Faites ensuite 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.
|
|
|
|
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 gwift-env
|
|
Include/ Lib/ Scripts/
|
|
|
|
Nous pouvons ensuite l'activer grâce à la commande `source gwift-env/bin/activate` avec `virtualenv` et `workon gwift-env` avec `virtualenvwrapper`.
|
|
|
|
A présent, tous les binaires présents dans 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 soient stockées dans le répertoire `gwift-env/Lib/site-packages/`. C'est notamment ici que nous retrouverons le code-source de Django, ainsi que des librairies externes une fois que nous les aurons installées.
|
|
|
|
.. code-block:: shell
|
|
|
|
$ tree sources/ .virtualenvs/
|
|
sources/
|
|
├── gwift-book
|
|
├── gwift-project
|
|
└── other-project
|
|
.virtualenvs/
|
|
├── env-01
|
|
└── env-02
|
|
|
|
Fichiers sources
|
|
================
|
|
|
|
Nous commençons par créer le répertoire du projet, à savoir `gwift-project`.
|
|
|
|
.. code-block:: shell
|
|
|
|
$ mkdir gwift-project
|
|
$ cd gwift-project
|
|
|
|
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 `django-admin startproject gwift`.
|
|
|
|
.. code-block:: shell
|
|
|
|
$ django-admin startproject gwift
|
|
|
|
Cette action aura 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
|
|
|
|
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.
|
|
* `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. Ceux-ci sont placés normalement 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
|
|
|
|
$ mkdir requirements
|
|
$ echo django >> requirements/base.txt
|