2019-08-11 10:11:35 +00:00
Installer le projet
===================
Dépendances du système
----------------------
Certaines dépendances sont nécessaires niveau système :
2021-10-15 16:12:56 +00:00
* poetry
2019-10-13 00:15:58 +00:00
* libmysqlclient
2019-08-11 10:11:35 +00:00
* libssl
* libjpeg
2021-10-15 16:12:56 +00:00
* libxapian-dev
2019-08-11 10:11:35 +00:00
* zlib1g-dev
* python3
2019-10-13 00:15:58 +00:00
* gettext
* graphviz
2019-08-11 12:11:00 +00:00
* mysql-client (pour migrer de l'ancien site)
2019-08-11 10:11:35 +00:00
2019-08-11 12:11:00 +00:00
Sur Ubuntu
~~~~~~~~~~
2019-08-11 10:11:35 +00:00
.. sourcecode :: bash
2021-11-19 12:10:18 +00:00
$ sudo apt install libssl-dev libjpeg-dev zlib1g-dev python3-dev libffi-dev python3-dev libgraphviz-dev pkg-config libxapian-dev gettext git
$ curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python3 -
2021-10-15 16:12:56 +00:00
# To include mysql for importing old bdd
2021-11-19 12:10:18 +00:00
$ sudo apt install libmysqlclient-dev
2019-08-11 10:11:35 +00:00
2019-08-11 12:11:00 +00:00
Sur MacOS
~~~~~~~~~
2019-08-11 10:11:35 +00:00
2019-08-11 21:10:09 +00:00
Pour installer les dépendances, il est fortement recommandé d'installer le gestionnaire de paquets `homebrew <https://brew.sh/index_fr> `_ .
2019-08-11 10:11:35 +00:00
.. sourcecode :: bash
2021-11-19 12:10:18 +00:00
$ brew install git python xapian graphviz poetry
2019-10-13 00:15:58 +00:00
# Si vous aviez une version de python ne venant pas de homebrew
2021-11-19 12:10:18 +00:00
$ brew link --overwrite python
2019-10-13 00:15:58 +00:00
# Pour bien configurer gettext
2021-11-19 12:10:18 +00:00
$ brew link gettext # (suivez bien les instructions supplémentaires affichées)
2019-10-13 00:15:58 +00:00
2021-10-15 16:12:56 +00:00
# Pour installer poetry
2021-11-19 12:10:18 +00:00
$ pip3 install poetry
2019-10-13 00:15:58 +00:00
.. note ::
Si vous rencontrez des erreurs lors de votre configuration, n'hésitez pas à vérifier l'état de votre installation homebrew avec :code: `brew doctor`
2019-08-11 10:11:35 +00:00
2021-11-19 12:10:18 +00:00
Sur Windows avec WSL
~~~~~~~~~~~~~~~~~~~~
.. note ::
Comme certaines dépendances sont uniquement disponible dans un environnement Unix, il est obligatoire de passer par WSL pour installer le projet.
.. sourcecode :: bash
# dans un shell Windows
> wsl --install
# afficher la liste des distribution disponible avec WSL
> wsl -l -o
# installer WSL avec une distro choisie
> wsl --install -d <nom_distro>
.. note ::
Si vous rencontrez le code d'erreur `` 0x80370102 `` , regardez les réponses de ce post https://askubuntu.com/questions/1264102/wsl-2-wont-run-ubuntu-error-0x80370102
Une fois WSL installé, mettez à jour votre distro & installez les dépendances:
.. sourcecode :: bash
# dans un shell Unix
$ sudo apt update
# libs
$ sudo apt install libssl-dev libjpeg-dev zlib1g-dev python3-dev libffi-dev python3-dev libgraphviz-dev pkg-config libxapian-dev gettext
$ curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python3 -
Vous devez **impérativement cloner le repo depuis Windows** car git ne fonctionne pas exactement de la même manière sous Unix (cf ce lien: https://stackoverflow.com/questions/62245016/how-to-git-clone-in-wsl).
Pour accéder à un disque externe à WSL, il suffit simplement d'utiliser la commande suivante:
.. sourcecode :: bash
# oui c'est beau, simple et efficace
$ cd /mnt/<lettre_disque>
2019-08-11 10:11:35 +00:00
Installer le projet
2021-11-19 12:10:18 +00:00
-----------------------------------
2019-08-11 10:11:35 +00:00
.. sourcecode :: bash
2021-11-19 12:10:18 +00:00
# ! A faire sous Windows pour ceux utilisant WSL
$ git clone https://ae-dev.utbm.fr/ae/Sith.git
$ cd Sith
2019-10-13 00:15:58 +00:00
2021-10-15 16:12:56 +00:00
# Création de l'environnement et installation des dépendances
2021-11-19 12:10:18 +00:00
$ poetry install
2019-08-11 10:11:35 +00:00
2021-10-15 16:12:56 +00:00
# Activation de l'environnement virtuel
2021-11-19 12:10:18 +00:00
$ poetry shell
2019-08-11 10:11:35 +00:00
2019-10-13 00:15:58 +00:00
# Prépare la base de donnée
2021-11-19 12:10:18 +00:00
$ python3 manage.py setup
2019-08-11 10:11:35 +00:00
2019-10-13 00:15:58 +00:00
# Installe les traductions
2021-11-19 12:10:18 +00:00
$ python3 manage.py compilemessages
2019-08-11 10:11:35 +00:00
2019-10-07 22:59:19 +00:00
.. note ::
2021-10-15 16:12:56 +00:00
Pour éviter d'avoir à utiliser la commande poetry shell systématiquement, il est possible de consulter :ref: `direnv` .
2019-10-07 22:59:19 +00:00
2019-08-11 10:11:35 +00:00
Configuration pour le développement
-----------------------------------
Lorsqu'on souhaite développer pour le site, il est nécessaire de passer le logiciel en mode debug dans les settings_custom. Il est aussi conseillé de définir l'URL du site sur localhost. Voici un script rapide pour le faire.
.. sourcecode :: bash
2021-11-19 12:10:18 +00:00
$ echo "DEBUG=True" > sith/settings_custom.py
$ echo 'SITH_URL = "localhost:8000"' >> sith/settings_custom.py
2019-08-11 10:11:35 +00:00
Démarrer le serveur de développement
------------------------------------
Il faut toujours avoir préalablement activé l'environnement virtuel comme fait plus haut et se placer à la racine du projet. Il suffit ensuite d'utiliser cette commande :
.. sourcecode :: bash
2021-11-19 12:10:18 +00:00
$ python3 manage.py runserver
2019-08-11 12:11:00 +00:00
2019-08-11 21:10:09 +00:00
.. note ::
2019-10-13 00:15:58 +00:00
Le serveur est alors accessible à l'adresse http://localhost:8000.
2019-08-11 12:11:00 +00:00
Générer la documentation
------------------------
La documentation est automatiquement mise en ligne sur readthedocs à chaque envoi de code sur GitLab.
2019-08-11 21:10:09 +00:00
Pour l'utiliser en local ou globalement pour la modifier, il existe une commande du site qui génère la documentation et lance un serveur la rendant accessible à l'adresse http://localhost:8080.
2019-10-13 01:15:49 +00:00
Cette commande génère la documentation à chacune de ses modifications, inutile de relancer le serveur à chaque fois.
2019-08-11 12:11:00 +00:00
.. sourcecode :: bash
2021-11-19 12:10:18 +00:00
$ python3 manage.py documentation
2019-08-12 22:02:34 +00:00
2019-10-13 01:15:49 +00:00
# Il est possible de spécifier un port et une adresse d'écoute différente
2021-11-19 12:10:18 +00:00
$ python3 manage.py documentation adresse:port
2019-10-13 01:15:49 +00:00
2019-08-12 22:02:34 +00:00
Lancer les tests
----------------
Pour lancer les tests il suffit d'utiliser la commande intégrée à django.
.. code-block :: bash
# Lancer tous les tests
2021-11-19 12:10:18 +00:00
$ python3 manage.py test
2019-08-12 22:02:34 +00:00
# Lancer les tests de l'application core
2021-11-19 12:10:18 +00:00
$ python3 manage.py test core
2019-08-12 22:02:34 +00:00
# Lancer les tests de la classe UserRegistrationTest de core
2021-11-19 12:10:18 +00:00
$ python3 manage.py test core.tests.UserRegistrationTest
2019-08-12 22:02:34 +00:00
# Lancer une méthode en particulier de cette même classe
2021-11-19 12:10:18 +00:00
$ python3 manage.py test core.tests.UserRegistrationTest.test_register_user_form_ok
2020-05-05 15:32:17 +00:00
Vérifier les dépendances Javascript
-----------------------------------
Une commande a été écrite pour vérifier les éventuelles mises à jour à faire sur les librairies Javascript utilisées.
N'oubliez pas de mettre à jour à la fois le fichier de la librairie, mais également sa version dans `sith/settings.py` .
.. code-block :: bash
# Vérifier les mises à jour
2021-11-19 12:10:18 +00:00
$ python3 manage.py check_front