Commit 11977ccc658861726e29100637596aa366510165
1 parent
0a1d6b07
Exists in
master
and in
4 other branches
Fix french typo
Showing
2 changed files
with
27 additions
and
33 deletions
Show diff stats
INSTALL.md
| @@ -3,9 +3,9 @@ | @@ -3,9 +3,9 @@ | ||
| 3 | ## Prérequis | 3 | ## Prérequis |
| 4 | 4 | ||
| 5 | - python3 | 5 | - python3 |
| 6 | -- sqlite ( pour le développement et les tests unitaires ) | ||
| 7 | -- chrome-driver et chromium ( pour les tests unitaires) | ||
| 8 | -- postgresql ou mysql/mariadb ( pour la production ) | 6 | +- SQLite (pour le développement et les tests unitaires) |
| 7 | +- chrome-driver et chromium (pour les tests unitaires) | ||
| 8 | +- postgresql ou mysql/mariadb (pour la production) | ||
| 9 | 9 | ||
| 10 | ## Obtenir un répertoire fonctionnel | 10 | ## Obtenir un répertoire fonctionnel |
| 11 | 11 | ||
| @@ -23,8 +23,8 @@ | @@ -23,8 +23,8 @@ | ||
| 23 | 23 | ||
| 24 | ### Configurer l'application | 24 | ### Configurer l'application |
| 25 | 25 | ||
| 26 | -Les fichiers de configuration fournis dans le répertoire ./resources sont à copier à la racine du projet, | ||
| 27 | -mais peuvent être laissés tels quels pour un premier test après installation. | 26 | +Les fichiers de configuration fournis dans le répertoire ./resources sont à copier à la racine du projet, mais peuvent |
| 27 | +être laissés tels quels pour un premier test après installation. | ||
| 28 | 28 | ||
| 29 | Il est bon d'y jeter un oeil, les commentaires sont là pour vous aider. | 29 | Il est bon d'y jeter un oeil, les commentaires sont là pour vous aider. |
| 30 | (mais en anglais comme tout le code source du projet) | 30 | (mais en anglais comme tout le code source du projet) |
| @@ -46,7 +46,7 @@ Il est bon d'y jeter un oeil, les commentaires sont là pour vous aider. | @@ -46,7 +46,7 @@ Il est bon d'y jeter un oeil, les commentaires sont là pour vous aider. | ||
| 46 | cp ./resources/flaskenv ./.flaskenv # ! noter le '.' devant le fichier destination | 46 | cp ./resources/flaskenv ./.flaskenv # ! noter le '.' devant le fichier destination |
| 47 | $(EDITOR) .flaskenv | 47 | $(EDITOR) .flaskenv |
| 48 | 48 | ||
| 49 | -### Créer la base de données | 49 | +### Créer la base de données |
| 50 | 50 | ||
| 51 | Dans un premier temps, pour tester l'installation, on peut s'appuyer sur une base déjà disponible. | 51 | Dans un premier temps, pour tester l'installation, on peut s'appuyer sur une base déjà disponible. |
| 52 | 52 | ||
| @@ -57,12 +57,11 @@ la diffusion de ces données de test avec le projet plan-de-charge. | @@ -57,12 +57,11 @@ la diffusion de ces données de test avec le projet plan-de-charge. | ||
| 57 | cp resources/lesia-btp.sqlite ./pdc-dev.db | 57 | cp resources/lesia-btp.sqlite ./pdc-dev.db |
| 58 | 58 | ||
| 59 | Vérifier que ce chemin correspond avec celui configuré dans le fichier `db_config.py` pour la | 59 | Vérifier que ce chemin correspond avec celui configuré dans le fichier `db_config.py` pour la |
| 60 | -variable `sqlalchemy_devdb_uri`. | ||
| 61 | -C'est le cas dans le fichier initial pour une variable `FLASK_ENV` positionnée à 'development'. | 60 | +variable `sqlalchemy_devdb_uri`. C'est le cas dans le fichier initial pour une variable `FLASK_ENV` positionnée à ' |
| 61 | +development'. | ||
| 62 | 62 | ||
| 63 | Pour un usage plus avancé, voyez l'outil en ligne de commande fourni avec l'application. | 63 | Pour un usage plus avancé, voyez l'outil en ligne de commande fourni avec l'application. |
| 64 | -(sinon, passez directement à la section suivante ) | ||
| 65 | - | 64 | +(sinon, passez directement à la section suivante) |
| 66 | 65 | ||
| 67 | # Créer la structure de la base | 66 | # Créer la structure de la base |
| 68 | # | 67 | # |
| @@ -89,7 +88,6 @@ Pour un usage plus avancé, voyez l'outil en ligne de commande fourni avec l'app | @@ -89,7 +88,6 @@ Pour un usage plus avancé, voyez l'outil en ligne de commande fourni avec l'app | ||
| 89 | flask --help | 88 | flask --help |
| 90 | flask pdc_db --help | 89 | flask pdc_db --help |
| 91 | 90 | ||
| 92 | - | ||
| 93 | ## Jouer les tests et exécuter un serveur local | 91 | ## Jouer les tests et exécuter un serveur local |
| 94 | 92 | ||
| 95 | pip install -r requirements-tests.txt | 93 | pip install -r requirements-tests.txt |
| @@ -100,13 +98,13 @@ Pour un usage plus avancé, voyez l'outil en ligne de commande fourni avec l'app | @@ -100,13 +98,13 @@ Pour un usage plus avancé, voyez l'outil en ligne de commande fourni avec l'app | ||
| 100 | # | 98 | # |
| 101 | PYTHONPATH=. pytest --cov=app --cov-report=xml:"coverage.xml" --cov-report=term --junitxml "tests-report.xml" | 99 | PYTHONPATH=. pytest --cov=app --cov-report=xml:"coverage.xml" --cov-report=term --junitxml "tests-report.xml" |
| 102 | 100 | ||
| 103 | -Enfin, ouvrir un serveur sur localhost:5000 et y accéder avec son navigateur. | 101 | +Enfin, ouvrir un serveur sur `localhost:5000` et y accéder avec son navigateur. |
| 104 | 102 | ||
| 105 | flask run | 103 | flask run |
| 106 | 104 | ||
| 107 | -## Configurer l'appli web avec apache | 105 | +## Configurer l'appli web avec apache |
| 108 | 106 | ||
| 109 | -### Les fichiers concernés: | 107 | +### Les fichiers concernés : |
| 110 | 108 | ||
| 111 | - pdc_web.wsgi | 109 | - pdc_web.wsgi |
| 112 | - pdc_web.py | 110 | - pdc_web.py |
| @@ -137,14 +135,13 @@ Enfin, ouvrir un serveur sur localhost:5000 et y accéder avec son navigateur. | @@ -137,14 +135,13 @@ Enfin, ouvrir un serveur sur localhost:5000 et y accéder avec son navigateur. | ||
| 137 | a2ensite pdc-web | 135 | a2ensite pdc-web |
| 138 | apachectl restart | 136 | apachectl restart |
| 139 | 137 | ||
| 140 | - | ||
| 141 | -## Mise à jour | 138 | +## Mise à jour |
| 142 | 139 | ||
| 143 | ### git pull | 140 | ### git pull |
| 144 | 141 | ||
| 145 | ### git autodeploy | 142 | ### git autodeploy |
| 146 | 143 | ||
| 147 | -Les fichiers concernés: | 144 | +Les fichiers concernés : |
| 148 | 145 | ||
| 149 | - scripts/post-deploy.sh | 146 | - scripts/post-deploy.sh |
| 150 | - resources/post-receive.git-hook | 147 | - resources/post-receive.git-hook |
| @@ -163,8 +160,8 @@ La procédure: | @@ -163,8 +160,8 @@ La procédure: | ||
| 163 | 160 | ||
| 164 | ## Gestion des utilisateurs | 161 | ## Gestion des utilisateurs |
| 165 | 162 | ||
| 166 | -La table `users` stocke les utilisateur qui se connectent à l'applicationa avec leur rôle et les droits associés. | ||
| 167 | -Un ensemble de commandes permet de les gérer: | 163 | +La table `users` stocke les utilisateurs qui se connectent à l'applicationa avec leur rôle et les droits associés. Un |
| 164 | +ensemble de commandes permet de les gérer : | ||
| 168 | 165 | ||
| 169 | flask pdc_db user_show_all # liste existante | 166 | flask pdc_db user_show_all # liste existante |
| 170 | flask pdc_db user_add # ajouter un nouveau login | 167 | flask pdc_db user_add # ajouter un nouveau login |
| @@ -172,31 +169,28 @@ Un ensemble de commandes permet de les gérer: | @@ -172,31 +169,28 @@ Un ensemble de commandes permet de les gérer: | ||
| 172 | flask pdc_db user_delete # effacer un login existant | 169 | flask pdc_db user_delete # effacer un login existant |
| 173 | flask pdc_db show_roles # lister les rôles disponibles | 170 | flask pdc_db show_roles # lister les rôles disponibles |
| 174 | 171 | ||
| 175 | -## Intégration Pycharm | 172 | +## Intégration Pycharm |
| 176 | 173 | ||
| 177 | -Ce projet utilisant le pattern "factory", il faut procéder | ||
| 178 | -à quelques configuration afin de le faire tourner avec | 174 | +Ce projet utilisant le pattern "factory", il faut procéder à quelques configurations afin de le faire tourner avec |
| 179 | pycharm. | 175 | pycharm. |
| 180 | 176 | ||
| 181 | -Pour une procédure détaillée, voir la page: | 177 | +Pour une procédure détaillée, voir la page : |
| 182 | 178 | ||
| 183 | https://flask.palletsprojects.com/en/1.1.x/cli/#pycharm-integration | 179 | https://flask.palletsprojects.com/en/1.1.x/cli/#pycharm-integration |
| 184 | 180 | ||
| 185 | -Dans le menu 'Edit Configurations', changer les champs: | 181 | +Dans le menu 'Edit Configurations', changer les champs : |
| 186 | 182 | ||
| 187 | - 'module name' positionné à 'flask' | 183 | - 'module name' positionné à 'flask' |
| 188 | -- et dans le champs 'Parameters' choisir 'run' | 184 | +- et dans le champ 'Parameters' choisir 'run' |
| 189 | 185 | ||
| 190 | - | ||
| 191 | -Cette configuration permet de lire les variables positionées dans le fichier .flaskenv | 186 | +Cette configuration permet de lire les variables positionées dans le fichier `.flaskenv` |
| 192 | 187 | ||
| 193 | FLASK_ENV=development | 188 | FLASK_ENV=development |
| 194 | FLASK_APP=pdc_web | 189 | FLASK_APP=pdc_web |
| 195 | 190 | ||
| 196 | - | ||
| 197 | -Ainsi fait, exécutez votre projet depuis pycharm et essayez sur un navigateur à l'adresse localhost:5000. | 191 | +Ainsi fait, exécutez votre projet depuis pycharm et essayez sur un navigateur à l'adresse `localhost:5000`. |
| 198 | 192 | ||
| 199 | ## Troubleshooting | 193 | ## Troubleshooting |
| 200 | 194 | ||
| 201 | -* Q: parfois le module Flask-Migrate n'est pas correctement chargé aprés son installation. | ||
| 202 | -* R: simplement recharger l'environnement virtuel avec `source venv/bin/activate` | 195 | +* Q : parfois le module Flask-Migrate n'est pas correctement chargé aprés son installation. |
| 196 | +* R : simplement recharger l'environnement virtuel avec `source venv/bin/activate` |
app/templates/base_page.html
| @@ -17,11 +17,11 @@ | @@ -17,11 +17,11 @@ | ||
| 17 | <span class="navbar-brand">{{current_user.name}}</span> | 17 | <span class="navbar-brand">{{current_user.name}}</span> |
| 18 | </li> | 18 | </li> |
| 19 | <li class="nav-item text-nowrap"> | 19 | <li class="nav-item text-nowrap"> |
| 20 | - <a class="nav-link" href="{{ url_for('auth.logout') }}">Déconnection</a> | 20 | + <a class="nav-link" href="{{ url_for('auth.logout') }}">Déconnexion</a> |
| 21 | </li> | 21 | </li> |
| 22 | {% else %} | 22 | {% else %} |
| 23 | <li class="nav-item text-nowrap"> | 23 | <li class="nav-item text-nowrap"> |
| 24 | - <a class="nav-link" href="{{ url_for('auth.login') }}">Connection</a> | 24 | + <a class="nav-link" href="{{ url_for('auth.login') }}">Connexion</a> |
| 25 | </li> | 25 | </li> |
| 26 | {% endif %} | 26 | {% endif %} |
| 27 | </ul> | 27 | </ul> |