realpython / realpython/python-guide

Expand on direnv section

Ouverte
#1,027 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Batchfile
Étoiles
29.8k
Forks
5.9k
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

The direnv section simply refers the reader to direnv.net for Linux installation instructions (by the the site is not linked on the page). Since there are different ways to get direnv working depending on if you're using pyenv, virtualenv, or virtualenvwrapper, it seems reasonable to direct them to the site. However, after struggling with this myself I found the instructions not straightforward, especially for a new user.
Since the direnv section directly follows the virtualenvwrapper section, I suggest updating with the following instructions to get direnv working with virtualenvwrapper:

  1. Add the following to ~/.config/direnv/direnvrc
layout_virtualenv {
    local venv_path="$1"
    source ${venv_path}/bin/activate
}
layout_virtualenvwrapper {
    local venv_path="${WORKON_HOME}/$1"
    layout_virtualenv $venv_path
}
  1. Add the following to an .envrc file in the root directory of your project
    layout virtualenvwrapper _name_of_virtual_environment_

Now, the virtual environment will activate when you enter the project directory and deactivate when you leave.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Repérez la section direnv immédiatement après la section virtualenvwrapper et vérifiez comment la documentation environnante renvoie vers les instructions d’installation externes. Ajoutez le lien direnv.net et les étapes de configuration de virtualenvwrapper fournies, puis vérifiez que le guide rendu explique clairement l’activation lors de l’entrée dans un répertoire de projet et de sa sortie.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
linux, python, shell
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
50/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.