Merge pull request #3 from inclusif/fix-poetry-install

Ajouter des instructions permettant d'installer poetry de manière isolée

README.md

@@ -1,26 +1,49 @@
-Template DataForGood
-================
-
-<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+# Template DataForGood
 
 This file will become your README and also the index of your
 documentation.
 
 # Contributing
 
+## Installer Poetry
 
-## Use a venv 
+Plusieurs [méthodes d'installation](https://python-poetry.org/docs/#installation) sont décrites dans la documentation de poetry dont:
 
-    python3 -m venv name-of-your-venv
+- avec pipx
+- avec l'installateur officiel
 
-    source name-of-your-venv/bin/activate
+Chaque méthode a ses avantages et inconvénients. Par exemple, la méthode pipx nécessite d'installer pipx au préable, l'installateur officiel utilise curl pour télécharger un script qui doit ensuite être exécuté et comporte des instructions spécifiques pour la completion des commandes poetry selon le shell utilisé (bash, zsh, etc...).
 
+L'avantage de pipx est que l'installation de pipx est documentée pour linux, windows et macos. D'autre part, les outils installées avec pipx bénéficient d'un environment d'exécution isolé, ce qui est permet de fiabiliser leur fonctionnement. Finalement, l'installation de poetry, voire d'autres outils est relativement simple avec pipx.
 
-## Utiliser Poetry
+Cependant, libre à toi d'utiliser la méthode qui te convient le mieux ! Quelque soit la méthode choisie, il est important de ne pas installer poetry dans l'environnement virtuel qui sera créé un peu plus tard dans ce README pour les dépendances de la base de code de ce repo git.
+
+### Installation de Poetry avec pipx
+
+Suivre les instructions pour [installer pipx](https://pipx.pypa.io/stable/#install-pipx) selon ta plateforme (linux, windows, etc...)
+
+Par exemple pour Ubuntu 23.04+:
+
+    sudo apt update
+    sudo apt install pipx
+    pipx ensurepath
+
+[Installer Poetry avec pipx](https://python-poetry.org/docs/#installing-with-pipx):
+
+    pipx install poetry
+
+### Installation de Poetry avec l'installateur officiel
 
-[Installer Poetry](https://python-poetry.org/docs/):
+L'installation avec l'installateur officiel nécessitant quelques étapes supplémentaires,
+se référer à la [documentation officielle](https://python-poetry.org/docs/#installing-with-the-official-installer).
 
-    python3 -m pip install "poetry==1.4.0"
+## Utiliser un venv python
+
+    python3 -m venv .venv
+
+    source .venv/bin/activate
+
+## Utiliser Poetry
 
 Installer les dépendances:
 
@@ -34,20 +57,12 @@ Mettre à jour les dépendances:
 
     poetry update
 
-## Utiliser Jupyter Notebook
-
-    jupyter notebook
-
-and check your browser !
-
 ## Lancer les precommit-hook localement
 
 [Installer les precommit](https://pre-commit.com/)
 
-
-    pre-commit run --all-files 
-
+    pre-commit run --all-files
 
 ## Utiliser Tox pour tester votre code
 
-    tox -vv
+    tox -vv