PyCharm 2024.1 Help

Create a Django project

Django project is intended for productive web development with Django. PyCharm takes care of creating specific directory structure and files required for a Django application, and providing the correct settings.

Enable the Django plugin

This functionality relies on the Django plugin, which is bundled and enabled in PyCharm by default. If the relevant features aren't available, make sure that you didn't disable the plugin.

  1. Press Ctrl+Alt+S to open settings and then select Plugins.

  2. Open the Installed tab, find the Django plugin, and select the checkbox next to the plugin name.

Create a new Django project

  1. Go to File | New Project, or click the New Project button in the Welcome screen. The New Project dialog opens.

    Create a Django project
  2. In the New Project dialog, do the following:

    • Specify project type Django.

    • Specify the project location.

    • Select Create Git repository to put the project under Git version control.

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

      Project venv

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

      Base conda

      PyCharm 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:

      Create a project with a conda environment
      • Select the Python version from the list.

      • Normally, PyCharm 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.

      Create a project with virtualenv
      • Specify the location of the new virtual environment in the Location field, or click Virtual environment location 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 Choose the base interpreter 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 PyCharm.

      Create a project with Pipenv

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

      Create a project with Poetry

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

      If PyCharm 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
      Selecting existing conda interpreter for a new project

      To reuse an existing conda environment:

      • Switch Type to Conda.

      • Normally, PyCharm 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.

      Selecting existing interpreter for a new project

      To reuse a Virtualenv, Pipenv, or Poetry environment:

      • Switch Type to Python.

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

  3. Click More settings More Settings, and specify the following:

    • From the Template language list, select the language to be used.

    • In the Templates folder field, specify the directory where the templates will be stored, and where they will be loaded from. You can specify the name of the directory that doesn't yet exist; in this case, the directory will be created.

    • In the Application name field, type the name of the Django application to be created.

    • If you need admin interface to be created, select the Enable Django admin checkbox.

  4. Click Create.

Last modified: 17 June 2024