IntelliJ IDEA 2018.3 Help

Creating Empty Python Project

To create an empty project:

  1. On the main menu, choose File | New | Project or on the Welcome screen, click New Project.

    New Project dialog box opens.

  2. In the left-hand pane of the New Project dialog box, select Python as a project type.

  3. In the right-hand pane, specify the project SDK. If the desired SDK is missing in the list, click New and create one of the following Python SDK:

    In the left-hand pane of the Add Python Interpreter dialog box, select Virtualenv Environment. The following actions depend on whether the virtual environment existed before.

    If New environment is selected:

    1. Specify the location of the new virtual environment in the text field, or click Virtual environment location and find location in your file system. Note that the directory where the new virtual environment should be located, must be empty!

    2. Choose the base interpreter from the drop-down list, or click Choose the base interpreter and find the base interpreter in the your file system.

    3. Select the Inherit global site-packages check-box if you want to inherit your global site-packages directory. This check-box corresponds to the --system-site-packages option of the virtualenv tool.

    4. Select the Make available to all projects check-box, if needed.

    If Existing environment is selected:

    1. Specify the required interpreter: use the drop-down list, or click Select an interpreter and find one in your file system.

    2. Select the check-box Make available to all projects, if needed.

    Click OK to complete the task.
    In the left-handed pane of the Add Python Interpreter dialog, select Pipenv.

    If you have added the user base’s 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:

    Path to the pipenve executable is autodetected

    Click OK to complete the task.

    If you have not modified the PATH variable, IntelliJ IDEA shows an error message: Pipenv executable is not found. Discover the proper executable path as described in the pipenv installation procedure and enter the target string in the Pipenv executable field, for example: C:\Users\jetbrains\AppData\Roaming\Python\Python37\Scripts\pipenv.exe (Windows) or /Users/jetbrains/.local/bin/pipenv (macOS).

    Click OK to save the changes and complete the task.

    In the left-hand pane of the Add Python Interpreter dialog box, select Conda Environment. The following actions depend on whether the Conda environment existed before.

    If New environment is selected:

    1. Specify the location of the new Conda environment in the text field, or click Conda environment location and find location in your file system. Note that the directory where the new Conda environment should be located, must be empty!

    2. Select the Python version from the drop-down list.

    3. Specify the location of the Conda executable file in the text field, or click Conda executable location and find location in the Conda installation directory.

    4. Select the Make available to all projects check-box, if needed.

    If Existing environment is selected:

    1. Specify the required interpreter: use the drop-down list, or click Select an interpreter and find one in your file system.

    2. Select the check-box Make available to all projects, if needed.

    Click OK to complete the task.
    In the left-hand pane of the Add Python Interpreter dialog box, select System Interpreter.
    Adding a system interpreter
    In the Interpreter field, type the fully-qualified path to the required interpreter executable, or click Browse icon and in the Select Java Interpreter dialog box that opens, choose the desired Java executable and click OK. Note that 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:
    System Interpreter warning message
    As prompted, consider using a virtual environment for your project. Click OK to complete the task.
    In the left-hand pane of the Add Python Interpreter dialog box, click SSH Interpreter. In the right-hand pane select New server configuration, then specify server information (host, port, and username).
    adding an interpreter via SSH
    Alternatively, you can select Existing server configuration and choose any available deployment configuration from the list.
    py existing ssh configuration
    If needed, click browseButton to review the Connection settings, Mappings, and Excluded paths for the selected deployment configuration. Click Next to continue configuring an interpreter. In the next dialog window, provide the authentication details to connect to the target server.
    specifying authentication details

    Select Password or Key pair (OpenSSL or PuTTY) and enter your password or passphrase.

    Click Next to proceed with the final configuration step.

    In the next dialog window, verify the path to the desired Java interpreted. You can accept default, or specify a different one. You have to configure the path mappings between your local project and the server. To do that, click browseButton 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.

    Setting SSH mappings

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

    Click Finish to complete adding an interpreter.
    In the left-hand pane of the Add Python Interpreter dialog box, click Vagrant:
    py vagrant add interpreter
    Click the browse button browseButton next to the field Vagrant instance folder, and specify the desired Vagrant instance folder.

    This results in showing the link to Vagrant host URL.

    The Python interpreter path field displays the path to the desired Python executable. You can accept default, or specify a different one. Click OK. The configured remote interpreter is added to the list.

    In the dialog box that opens, select the Docker option, from the drop-down lists select the Docker server (if the server is missing, click New...), and specify the image name.

    Python interpreter path should have the default value, for example, python:

    py choose docker

    Click OK to complete the task.

    In the dialog box that opens, select the Docker Compose option, from the drop-down lists select the Docker server, Docker Compose service (here web), configuration file (here docker-compose.yml)and image name (here python).

    Next, wait while IntelliJ IDEA starts your Docker-Compose configuration to scan and index:

    Configure remote Python interpreter

    Click OK to complete the task.

  4. If needed, select additional libraries and frameworks to enable with the project. When selecting a particular framework, ensure that it is supported by the specified project SDK. Also, provide the required parameters.

  5. Click Next.

  6. On the next page, select the Create project from template checkbox if you want to use a project or framework template for the new Python project.

  7. Specify the project name and location.

  8. Click Finish to complete the task.

Last modified: 7 December 2018

See Also