realpython / realpython/python-guide
Expand on direnv section
まだ誰も着手していません。
- 主要言語
- Batchfile
- スター
- 29.8k
- フォーク
- 5.9k
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
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:
- 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
}
- 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.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
virtualenvwrapper セクションの直後にある direnv セクションを見つけ、周辺のドキュメントが外部のインストール手順にどのようにリンクしているかを確認します。direnv.net リンクと、提供されている virtualenvwrapper のセットアップ手順を追加し、レンダリングされたガイドで、プロジェクトディレクトリに入るときと出るときの有効化が明確に説明されていることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- linux, python, shell
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 50/100