[PYTHON] PyCharm remote interpreter with SSH (WSL2, venv, pyenv)

Overview

• PyCharm：PyCharm 2020.01 Professional
• WS2 ：Ubuntu20.04LTS
• python: 3.8.0 (actually tried version)
• Version control: pyenv
• Virtual environment management: venv
• Reference
• I wanted to write Django with WSL + Pycharm
• JetBrains Official Manual Japanese Version PyCharm SSH Credentials for Remote Python Interpreter Settings

Start SSH server with bash (WSL)

bash

sudo service ssh start
ssh 127.0.0.1

#If that doesn't work, try the following:
sudo ssh-keygen -A
sudo service ssh restart
ssh 127.0.0.1

Launch a virtual environment from bash (WSL)

Launch the project directory in PyCharm Professional, open terminal and switch to bash

cmd@/Users/~/{project-dir}

bash

Like bash @ / mnt / c / Users / ~~ / {project-dir}, The current directory moves to the location where the directory that started bash is mounted.

Create a virtual environment from bash

bash@/mnt/c/Users/~~/{project-dir}

#If you are using pyenv"home/.pyenv/shims/python"Point to(global python)
python which

#Confirmation of global version
python --version

#If you want to use a different version, specify the local version here
pyenv local {version}

# bash(WSL)Create venv from(If there is an existing venv created from cmd or ps, create it with a name that will not be covered)
python -m venv {venv-name}

Start venv

bash@/mnt/c/Users/~~/{project-dir}

#start venv
. {venv-name}/bin/activate

# "/mnt/c/Users/~~/{venv-name}/bin/python"Point to(Virtual environment python)
python which
pip install --upgrade pip

Make an SSH connection with PyCharm and set up Remote Interpreter

• Transition as follows from the File tab at the top of pycharm
• File> settings> Project: {project-name}> Python Interpreter> Gear button> Show All> + button> SSH Interpreter
• Enter the following * HOST：localhost or 127.0.0.1
• Username: Ubuntu username * Port：22
• Authentication type-> Password: Ubuntu user password
• Set Project Path Mappings * Local Path
• Project directory as seen from windows C: / Users / ~~ / {project-dir} * Remote Path
• Project directory seen (mounted) from WSL / mnt / c / Users / ~~ / {venv-name} / bin / python

Package installation

bash@/mnt/c/Users/~~/{project-dir}

pip install -r requirements.txt

• File> settings> Project: {project-name}> Make sure the package is loaded correctly from Python Interpreter
• Check if the console launches correctly from the Python Console and if the packages installed by Interpreter can be imported.

【important point】

• When creating venv from bash
• If venv originally created in the Windows environment (cmd) exists in {project-dir}, create it with a name that does not overlap with the existing venv.
• When launching venv from bash
• If you perform pip install from requirements.txt created in Windows environment from bash, an error may occur.
• Ex.) The package psycopg2 for handling PostgreSQL with Django needs to be installed by replacing it with psycopg2-binary.