From 87eee41eeb595aab08987be5e1648e670a4fa746 Mon Sep 17 00:00:00 2001 From: Calum Mackervoy Date: Wed, 3 Jul 2024 12:30:15 +0200 Subject: [PATCH] README: add venv activation info MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fix text README Co-authored-by: François Freitag Fix text README Co-authored-by: François Freitag doc: ajout des liens doc(README.md): correction de grammaire --- README.md | 7 ++++++- docs/developing.md | 2 +- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d7048548c5..be0f9baf46 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Cependant, il est recommandé d'en prendre connaissance pour noter par exemple que les emails ne sont pas réellement envoyés mais que leur contenu est simplement écrit dans la sortie standard. -Le reste de la configuration se fait avec des variables d'environnement. +Le reste de la configuration se fait avec des [variables d'environnement](./docs/environment.md). Celles concernant notre hébergeur CleverCloud sont définis au niveau du déploiement et de l'app CleverCloud tandis que les autres paramètres applicatifs indépendants du PaaS @@ -88,6 +88,11 @@ $ make venv Dans un `virtualenv`, vous pouvez utiliser les commandes Django habituelles (`./manage.py`) mais également les recettes du [Makefile](./Makefile). +Par défaut l'environment sera stocké dans le répertoire `.venv`. En bash/zsh c'est activé +avec la commande `source .venv/bin/activate` ([doc](https://docs.python.org/3/library/venv.html#how-venvs-work)). + +Il est recommandé d'utiliser [direnv](./docs/developing.md) qui permet l'activation de l'environment automatique. + ### Création des *buckets S3* Les fichiers téléversés sont enregistrés dans un stockage objet type *S3*. En diff --git a/docs/developing.md b/docs/developing.md index 0385bfdefe..aefdef74b0 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -2,7 +2,7 @@ ## direnv -Nous conseillons d'installer le minuscule utilitaire `direnv` pour charger et +Nous conseillons d'installer le minuscule utilitaire [direnv](https://direnv.net/) pour charger et décharger automatiquement des variables d'environnement à l'entrée dans un répertoire.