Configure a Python SDK

1. Ensure that you have downloaded and installed Python on your computer.

   Installing Python on Windows from Microsoft Store

   If you are on Windows, you can download Python from the Microsoft Store and install it as a Python interpreter. Once the Python application is downloaded from the Microsoft Store, it becomes available in the list of the Python executables.

   Note that interpreters added from the Microsoft Store installations come with some limitations. Because of restrictions on Microsoft Store apps, Python scripts may not have full write access to shared locations such as TEMP and the registry.

2. Navigate to File | Project Structure or press Ctrl+Alt+Shift+S.

3. In the Project Structure dialog, select SDKs under the Platform Settings section, click , and choose Add Python SDK from the popup menu.

   

4. In the left-hand pane of the Add Python Interpreter dialog, select System Interpreter.

   

5. In the Interpreter drop-down, select one of the Python interpreters that have been installed in your system, or click and in the Select Python Interpreter dialog that opens, choose the desired Python executable.

   

   You will need admin privileges to install, remove, and upgrade packages for the system interpreter. When attempting to install an interpreter package through an intention action, you might receive the following error message:

   

   As prompted, consider using a virtual environment for your project.

6. Click OK to complete the task.

For more information, refer to the PyCharm documentation.

1. Navigate to File | Project Structure or press Ctrl+Alt+Shift+S.

2. In the Project Structure dialog, select SDKs under the Platform Settings section, click , and choose Add Python SDK from the popup menu.

   

3. In the left-hand pane of the Add Python Interpreter dialog, select Virtualenv Environment.

   

4. The following actions depend on whether you want to create a new virtual environment or to use an existing one.

   New virtual environment

   • Specify the location of the new virtual environment in the Location field, or click and browse for the location in your file system. The directory for the new virtual environment should be empty.

   • Choose the base interpreter from the list, or click and find the Python executable in your file system.

   • Select the Inherit global site-packages checkbox if you want all packages installed in the global Python on your machine to be added to the virtual environment you're going to create. This checkbox corresponds to the --system-site-packages option of the virtualenv tool.

   • Select the Make available to all projects checkbox if you want to reuse this environment when creating Python interpreters in Aqua.

   Existing virtual environment

   • Choose the desired interpreter from the list.

   • If the desired interpreter is not on the list, click , and then browse for the desired Python executable (for example, venv/bin/python on macOS or venv\Scripts\python.exe on Windows).

   The selected virtual environment will be reused for the current project.

5. Click OK to complete the task.

For more information, refer to the PyCharm documentation.

1. Ensure that Anaconda or Miniconda is downloaded and installed on your computer, and you're aware of a path to its executable file.

   For more information, refer to the installation instructions.

2. Navigate to File | Project Structure or press Ctrl+Alt+Shift+S.

3. In the Project Structure dialog, select SDKs under the Platform Settings section, click , and choose Add Python SDK from the popup menu.

   

4. In the left-hand pane of the Add Python Interpreter dialog, select Conda Environment.

   

5. The following actions depend on whether you want to create a new conda environment or to use an existing one.

   New conda environment

   • Specify the location of the new conda environment in the Location field, or click and browse for the desired location in your file system. The directory for the new conda environment should be empty.

   • Select the Python version from the list.

   • Normally, Aqua will detect conda installation.

     Otherwise, specify the location of the conda executable, or click to browse for it.

   • Select the Make available to all projects checkbox if you want to reuse this environment when creating Python interpreters in Aqua.

   Existing conda environment

   • Select the environment from the list.

   • If the desired interpreter is not on the list, click , and then browse for the Python executable within the previously configured conda environment.

   • If necessary, specify the location of the conda executable, or click to browse for it.

   • Select the Make available to all projects checkbox if you want to reuse this environment when creating Python interpreters in Aqua.

   The selected conda environment will be reused for the current project.

6. Click OK to complete the task.

For more information, refer to the PyCharm documentation.

1. Navigate to File | Project Structure or press Ctrl+Alt+Shift+S.

2. In the Project Structure dialog, select SDKs under the Platform Settings section, click , and choose Add Python SDK from the popup menu.

   

3. In the left-hand pane of the Add Python Interpreter dialog, select Pipenv Environment.

   

4. Choose the base interpreter from the list, or click and find the Python executable in your file system.

5. If your project contains Pipfile, you can choose whether you want to install the packages listed in it by enabling or disabling the Install packages from Pipfile checkbox. By default, the checkbox is enabled.

6. If you have added the base binary directory to your PATH environmental variable, you don't need to set any additional options: the path to the pipenv executable will be autodetected.

   If the pipenv executable is not found, follow the pipenv installation procedure to discover the executable path, and then specify it in the dialog.

7. Click OK to complete the task.

When you have set the pipenv virtual environment as a Python interpreter, all available packages are added from the source defined in Pipfile. The packages are installed, removed, and updated in the list of the packages through pipenv rather than through pip.

For more information, refer to the PyCharm documentation.

1. Navigate to File | Project Structure or press Ctrl+Alt+Shift+S.

2. In the Project Structure dialog, select SDKs under the Platform Settings section, click , and choose Add Python SDK from the popup menu.

   

3. In the left-hand pane of the Add Python Interpreter dialog, select Poetry Environment.

   

4. The following actions depend on whether you want to create a new Poetry environment or to use an existing one.

   New Poetry environment

   • Select Poetry Environment.

   • Choose the base interpreter from the list, or click and find the Python executable in your file system.

   • If your project contains pyproject.toml, you can choose whether you want to install the packages listed in it by enabling or disabling the Install packages from pyproject.toml checkbox. By default, the checkbox is enabled.

   • If Aqua doesn't detect the poetry executable, specify the following path in the dialog, replacing jetbrains with your username:

     /Users/jetbrains/Library/Application Support/pypoetry/venv/bin/poetry

     C:\Users\jetbrains\AppData\Roaming\pypoetry\venv\Scripts\poetry.exe

     /home/jetbrains/.local/bin/poetry

   Existing Poetry environment

   • Make sure that the project directory contains a pyproject.toml file.

   • Select Existing environment. Then expand the Interpreter list and choose the desired interpreter.

   • If the desired interpreter is not on the list, click , and then browse for the Python executable within the previously configured Poetry environment.

   The selected Poetry environment will be reused for the current project.

5. Click OK to complete the task.

For more information, refer to the PyCharm documentation.

1. Click the Windows button in the lower-left corner of the screen and start typing System Information. To ensure that your system works well with WSL, upgrade your Windows to the latest available version.

2. Install the Windows Subsystem for Linux and initialize your Linux distribution as described in the WSL Installation Guide.

3. If your Linux distribution doesn't come with rsync, you need to install it:

   sudo apt install rsync

   sudo pacman -S rsync

4. Navigate to File | Project Structure or press Ctrl+Alt+Shift+S.

5. In the Project Structure dialog, select SDKs under the Platform Settings section, click , and choose Add Python SDK from the popup menu.

   

6. In the left-hand pane of the Add Python Interpreter dialog, select WSL.

7. Select the Linux distribution with the required Python interpreter.

8. In Python interpreter path field, specify the path to the Python executable. You can accept the default, type in a different path, or click to browse.

   

9. Click OK.

   The configured remote interpreter is added to the list.

1. Ensure that the following prerequisites are met (outside of Aqua):

   • One of supported Vagrant providers is installed on your computer.

   • Vagrant is installed on your computer, and all the necessary infrastructure is created.

   • The parent folders of the following executable files have been added to the system PATH variable:

     • vagrant.bat or vagrant from your Vagrant installation. This should be done automatically by the installer.

     • VBoxManage.exe or VBoxManage from your Oracle's VirtualBox installation.

   • The required virtual boxes are created.

2. Make sure that the Vagrant plugin is enabled.

3. Ensure that you have properly initiated and started Vagrant. Basically, you need to open the Terminal window and execute the following commands:

   $ vagrant init ubuntu/trusty64

   and

   $ vagrant up

   For more information, refer to Vagrant documentation.

4. Navigate to File | Project Structure or press Ctrl+Alt+Shift+S.

5. In the Project Structure dialog, select SDKs under the Platform Settings section, click , and choose Add Python SDK from the popup menu.

   

6. In the left-hand pane of the Add Python Interpreter dialog, select Vagrant.

7. In Python interpreter path field, specify the path to the Python executable. You can accept the default, type in a different path, or click to browse.

   

8. Click OK.

   The configured remote interpreter is added to the list.

1. Ensure that there is an SSH server running on a remote host, since Aqua runs remote interpreters via ssh-sessions.

2. Navigate to File | Project Structure or press Ctrl+Alt+Shift+S.

3. In the Project Structure dialog, select SDKs under the Platform Settings section, click , and choose Add Python SDK from the popup menu.

   

4. Select New server configuration, then specify server information (host, port, and username).

   

   Alternatively, you can select Existing server configuration and choose any available deployment configuration from the list.

   

   If needed, click to review the Connection settings, Mappings, and Excluded paths for the selected deployment configuration. Click Next to continue configuring an interpreter.

5. In the next dialog window, provide the authentication details to connect to the target server.

   

   Select Password or Key pair (OpenSSH or PuTTY) and enter your password or passphrase. If Key pair (OpenSSH or PuTTY) is selected, specify:

   • Private key: location of the file with a private key

   • Passphrase: similar to a password, it serves to encrypt the private key.

   Click Next to proceed.

6. In the next dialog window, verify the path to the desired Python interpreter. You can accept the default, or specify a different one. You have to configure the path mappings between your local project and the server. To do that, click next to the Sync folders field and enter the path to the local project folder and the path to the folder on the remote server.

   

   You can also select the checkbox to enable automatic upload of the local changes to the remote server.

7. Click OK.

   The configured remote interpreter is added to the list.

1. Make sure that the following prerequisites are met:

   • Docker is installed, as described in the Docker documentation.

   • You have stable Internet connection, so that Aqua can download and run busybox:latest (the latest version of the BusyBox Docker Official Image). Once you have successfully configured an interpreter using Docker, you can go offline.

   Note that you cannot install any Python packages into Docker-based project interpreters.

2. Navigate to File | Project Structure or press Ctrl+Alt+Shift+S.

3. In the Project Structure dialog, select SDKs under the Platform Settings section, click , and choose Add Python SDK from the popup menu.

   

4. In the left-hand pane of the Add Python Interpreter dialog, select Docker.

   

5. Select an existing Docker configuration in the Docker server dropdown.

   Alternatively, click New and perform the following steps to create a new Docker configuration:

   Create a Docker configuration

   Click to add a Docker configuration and specify how to connect to the Docker daemon.

   The connection settings depend on your Docker version and operating system. For more information, refer to Docker connection settings.

   The Connection successful message should appear at the bottom of the dialog.

   

   This table is not available on a Linux host, where Docker runs natively and you can mount any directory to the container.

6. Specify the image and the path to the Python executable:

   

7. Click OK.

   The configured remote interpreter is added to the list.

1. Make sure that the following prerequisites are met:

   • Docker is installed, as described in the Docker documentation.

   • You have stable Internet connection, so that Aqua can download and run busybox:latest (the latest version of the BusyBox Docker Official Image). Once you have successfully configured an interpreter using Docker, you can go offline.

   Note that you cannot install any Python packages into Docker-based project interpreters.

2. Navigate to File | Project Structure or press Ctrl+Alt+Shift+S.

3. In the Project Structure dialog, select SDKs under the Platform Settings section, click , and choose Add Python SDK from the popup menu.

   

4. In the left-hand pane of the Add Python Interpreter dialog, select Docker Compose.

   

5. Select Docker configuration in the Server dropdown.

6. Specify the docker-compose.yml file in Configuration files and select the service.

   

   Optionally, specify environment variables and edit the Compose project name.

7. Finally, specify the path to the Python executable:

   

8. Click OK.

   The configured remote interpreter is added to the list.