From d66533bd671fd3bfc603a845a99b2c12ee6f1b33 Mon Sep 17 00:00:00 2001 From: Luis Arias Date: Tue, 13 Feb 2024 14:26:24 +0100 Subject: [PATCH 1/3] =?UTF-8?q?Ajouter=20des=20instructions=20permettant?= =?UTF-8?q?=20d'installer=20poetry=20de=20mani=C3=A8re=20isol=C3=A9e?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 41 +++++++++++++++++++++++------------------ 1 file changed, 23 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 3a03607..a3fedf0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -Template DataForGood -================ +# Template DataForGood @@ -9,18 +8,32 @@ documentation. # Contributing -## Use a venv +## Installer pipx - python3 -m venv name-of-your-venv +[Installer pipx](https://pipx.pypa.io/stable/#install-pipx) - source name-of-your-venv/bin/activate +Par exemple pour Ubuntu: + sudo apt update + sudo apt install pipx + pipx ensurepath -## Utiliser Poetry -[Installer Poetry](https://python-poetry.org/docs/): +## Installer Poetry + +[Installer Poetry](https://python-poetry.org/docs/#installing-with-pipx): + + pipx install poetry + + +## Use a venv + + python3 -m venv .venv + + source .venv/bin/activate - python3 -m pip install "poetry==1.4.0" + +## Utiliser Poetry Installer les dépendances: @@ -34,20 +47,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 \ No newline at end of file + tox -vv From 6aeecf8070ff9526bc2c3cb72fdfd7c60768d5f6 Mon Sep 17 00:00:00 2001 From: Luis Arias Date: Tue, 13 Feb 2024 14:30:49 +0100 Subject: [PATCH 2/3] Formattage markdown --- README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/README.md b/README.md index a3fedf0..2461d85 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,6 @@ documentation. # Contributing - ## Installer pipx [Installer pipx](https://pipx.pypa.io/stable/#install-pipx) @@ -18,21 +17,18 @@ Par exemple pour Ubuntu: sudo apt install pipx pipx ensurepath - ## Installer Poetry [Installer Poetry](https://python-poetry.org/docs/#installing-with-pipx): pipx install poetry - ## Use a venv python3 -m venv .venv source .venv/bin/activate - ## Utiliser Poetry Installer les dépendances: From 422673b1da2bba0b953768707964e49b15da2109 Mon Sep 17 00:00:00 2001 From: Luis Arias Date: Tue, 13 Feb 2024 22:13:06 +0100 Subject: [PATCH 3/3] Clarifier que l'installation de poetry avec pipx est une option, mais semble l'approche la plus simple. --- README.md | 32 +++++++++++++++++++++++--------- 1 file changed, 23 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 2461d85..18fcc3f 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,43 @@ # Template DataForGood - - This file will become your README and also the index of your documentation. # Contributing -## Installer pipx +## Installer Poetry + +Plusieurs [méthodes d'installation](https://python-poetry.org/docs/#installation) sont décrites dans la documentation de poetry dont: + +- avec pipx +- avec l'installateur officiel + +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. -[Installer pipx](https://pipx.pypa.io/stable/#install-pipx) +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. -Par exemple pour Ubuntu: +### 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 - -[Installer Poetry](https://python-poetry.org/docs/#installing-with-pipx): +[Installer Poetry avec pipx](https://python-poetry.org/docs/#installing-with-pipx): pipx install poetry -## Use a venv +### Installation de Poetry avec l'installateur officiel + +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). + +## Utiliser un venv python python3 -m venv .venv