IntelliJ IDEA 2023.3 Help

Django support

Prerequisite

Django framework and the corresponding Python interpreter are properly installed on your machine.

Supported versions of Django and Python

IntelliJ IDEA supports the latest Django versions. The corresponding Python versions depend on Django. See What Python version can I use with Django?

Django support

Django support in IntelliJ IDEA includes:

Enabling or disabling Django support

Django support for a Python project can be turned on or off by attaching or detaching the Django facet.

Enable Django support

  1. In the main menu, go to File | Project Structure Control+Alt+Shift+S.

  2. Select Modules in Project Settings on the left pane, and then do one of the following:

    • If there is a Python module to which Django support should be added, right-click it, and then select Add | Django from the context menu.

      Adding Django support to a module in the Project Structure dialog

      Select the Django node under the module node and specify the required parameters in the right-hand pane.

      Django node
    • If there is no Python module, click the Add button above the list of modules, and then select New Module from the popup menu. The New Module dialog opens.

      Adding a new Django module

      In the New Module dialog, do the following:

      • Specify module type Django.

      • Specify the project location.

      • If you want to proceed with the Project venv or Base conda interpreter, select the corresponding option and click Create.

        Project venv

        IntelliJ IDEA creates a virtualenv environment based on the system Python in the project folder.

        Base conda

        IntelliJ IDEA configures conda base environment as the project interpreter.

        To configure an interpreter of other type or to use an existing environment, select Custom environment.

        The following steps depend on your choice:

        • Select the Python version from the list.

        • Normally, IntelliJ IDEA will detect conda installation.

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

        • Specify the environment name.

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

        • Choose the base interpreter from the list, or click Choose the base interpreter and find the desired 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 IntelliJ IDEA.

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

        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.

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

        If IntelliJ IDEA 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

        To reuse an existing conda environment:

        • Switch Type to Conda.

        • Normally, IntelliJ IDEA will detect conda installation.

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

        • Select the environment from the list. If you specified the path to conda manually, you may need to reload environments.

        To reuse a Virtualenv, Pipenv, or Poetry environment:

        • Switch Type to Python.

        • Select the Python executable from the list or click App expui inline browse to browse for it.

      Click Create.

  3. Click OK to apply the changes.

Disable Django support

  1. In the main menu, go to File | Project Structure Control+Alt+Shift+S.

  2. Select Modules in Project Settings on the left pane, and then expand the Python module for which Django support should be disabled.

  3. Select the Django node and click The Delete button above the list of modules.

    Disabling Django support
Last modified: 11 January 2024