Run/Debug Configuration: Django Server

Enable the Django plugin

This functionality relies on the Django plugin, which is bundled and enabled in PyCharm by default. If the relevant features are not available, make sure that you did not disable the plugin.

Press Ctrl+Alt+S to open settings and then select Plugins.
Open the Installed tab, find the Django plugin, and select the checkbox next to the plugin name.

Use this dialog to create run/debug configuration for Django server.

Configuration tab

Item

Description

Host

In this field, specify the host name to be used.

Port

In this field, specify the port number where the server will start.

Additional options

In this field, specify the options of the django-admin.py utility. For more information, refer to the django-admin.py and manage.py documentation.

Run browser

Select this checkbox, if you want your Django application to open in the default browser. In the text field below, enter the IP address where your application will be opened.

Test server

If this checkbox is selected, a Django development server is launched with the test database.

If this checkbox is not selected, the development server will be used.

No reload

If this checkbox is selected, the -- noreload option of the runserver command becomes enabled. If this checkbox is not selected, PyCharm will not select it automatically, which means that debugging in autoreload mode is possible.

For more information, refer to the option description.

This field is only available when the Test server checkbox is cleared.

Custom run command

Specify here the custom command you want to register with manage.py utility. Such command, being properly added to your project, becomes available via the Run manage.py task command on the Tools menu.

For more information, refer to Writing custom django-admin commands.

Project

Click this list to select one of the projects, opened in the same PyCharm window, where this run/debug configuration should be used. If there is only one open project, this field is not displayed.

Environment variables

This field shows the list of environment variables. If the list contains several variables, they are delimited with semicolons.

By default, the field contains the variable PYTHONUNBUFFERED set to 1. To fill in the list, click the browse button, or press Shift+Enter and specify the desired set of environment variables in the Environment Variables dialog.

To create a new variable, click , and type the desired name and value.

You might want to populate the list with the variables stored as a series of records in a text file, for example:

                        Variable1 = Value1
                        Variable2 = Value2
                    

Just copy the list of variables from the text file and click Paste () in the Environmental Variables dialog. The variables will be added to the table. Click Ok to complete the task. At any time, you can select all variables in the Environment Variables dialog, click Copy , and paste them into a text file.

Python Interpreter

Select one of the pre-configured Python interpreters from the list.

Interpreter options

In this field, specify the command-line options to be passed to the interpreter. If necessary, click , and type the string in the editor.

Working directory

Specify a directory to be used by the running task.

When a default run/debug configuration is created by the keyboard shortcut Ctrl+Shift+F10, or by choosing Run from the context menu of a script, the working directory is the one that contains the executable script. This directory may differ from the project directory.
When this field is left blank, the bin directory of the PyCharm installation will be used.

You can use path variables in this field.

Add content roots to PYTHONPATH

Select this checkbox to add all content roots of your project to the environment variable PYTHONPATH;

Add source roots to PYTHONPATH

Select this checkbox to add all source roots of your project to the environment variable PYTHONPATH;

Docker container settings

Click to open the dialog and specify the following settings:

Options

Publish all ports: Expose all container ports to the host. This corresponds to the option --publish-all.
Port bindings: Specify the list of port bindings. Similar to using the -p option with docker run.
Volume bindings: Use this field to specify the bindings between the special folders-volumes and the folders of the computer, where the Docker daemon runs. This corresponds to the -v option. For more information, refer to Managing data in containers.
Environment variables: Use this field to specify the list of environment variables and their values. This corresponds to the -e option. For more information, refer to ENV (environment variables).
Run options: Use this field to specify the Docker command-line options.

Click to expand the tables. Click , , or to make up the lists.

Docker Compose

Commands and options

You can use the following commands of the Docker Compose Command-Line Interface:

Commands	Supported options
up: Builds, creates, starts, and attaches to containers for a service.	`--abort-on-container-exit` `--build` `--exit-code-from SERVICE` `--scale SERVICE=NUM...` `--timeout TIMEOUT`
run: Runs a one-time command against a service.	`--entrypoint CMD` `-l, --label KEY=VAL` `--name NAME` `-p, --publish=[]` `--rm` `--service-ports` `--use-aliases` `-u, --user=""` `-v, --volume=[]`
exec: Runs arbitrary commands in your services.	`--index=index` `--privileged` `-u, --user USER`

Command preview

Use this field to preview the complete command string.

For example, the up --build exec --user jetbrains combination in the Commands and options field produces the following output in the preview:

                docker compose
                -f C:\PyCharm-2019.2\Demos\djangodocker-master\docker-compose.yml
                <override configuration file>
                up --build exec --user jetbrains
            

Logs tab

Use this tab to specify which log files generated while running or debugging should be displayed in the console, that is, on the dedicated tabs of the Run or Debug tool window.

Item	Description
Is Active	Select checkboxes in this column to have the log entries displayed in the corresponding tabs in the Run tool window or Debug tool window.
Log File Entry	The read-only fields in this column list the log files to show. The list can contain: Full paths to specific files. Aliases to substitute for full paths or patterns. These aliases are also displayed in the headers of the tabs where the corresponding log files are shown. If a log entry pattern defines more than one file, the tab header shows the name of the file instead of the log entry alias.
Skip Content	Select this checkbox to have the previous content of the selected log skipped.
Save console output to file	Select this checkbox to save the console output to the specified location. Type the path manually, or click the browse button and point to the desired location in the dialog that opens.
Show console when a message is printed to standard output stream	Select this checkbox to activate the output console and bring it forward if an associated process writes to Standard.out.
Show console when a message is printed to standard error stream	Select this checkbox to activate the output console and bring it forward if an associated process writes to Standard.err.
	Click this button to open the Edit Log Files Aliases dialog where you can select a new log entry and specify an alias for it.
	Click this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.
	Click this button to remove the selected log entry from the list.
	Click this button to edit the select log file entry. The button is available only when an entry is selected.

Common settings

When you edit a run configuration (but not a run configuration template), you can specify the following options:

Item	Description
Name	Specify a name for the run configuration to quickly identify it among others when editing or running.
Allow multiple instances	Allow running multiple instances of this run configuration in parallel. By default, it is disabled, and when you start this configuration while another instance is still running, PyCharm suggests stopping the running instance and starting another one. This is helpful when a run configuration consumes a lot of resources and there is no good reason to run multiple instances.
Store as project file	Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project. By default, it is disabled, and PyCharm stores run configuration settings in .idea/workspace.xml.

Item

Description

Name

Specify a name for the run configuration to quickly identify it among others when editing or running.

Allow multiple instances

Allow running multiple instances of this run configuration in parallel.

By default, it is disabled, and when you start this configuration while another instance is still running, PyCharm suggests stopping the running instance and starting another one. This is helpful when a run configuration consumes a lot of resources and there is no good reason to run multiple instances.

Store as project file

Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project.

By default, it is disabled, and PyCharm stores run configuration settings in .idea/workspace.xml.

The tree view of run/debug configurations has a toolbar that helps you manage configurations available in your project as well as adjust default configurations templates.

Item	Shortcut	Description
	`Alt+Insert`	Create a run/debug configuration.
	`Alt+Delete`	Delete the selected run/debug configuration. Note that you cannot delete default configurations.
	`Ctrl+D`	Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.
		The button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.
		Move into new folder / Create new folder. You can group run/debug configurations by placing them into folders. To create a folder, select the configurations within a category, click , and specify the folder name. If only a category is in focus, an empty folder is created. Then, to move a configuration into a folder, between the folders or out of a folder, use drag or and buttons. To remove grouping, select a folder and click .
		Click this button to sort configurations in the alphabetical order.

Before launch

In this area, you can specify tasks to be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.

Item	Shortcut	Description
	`Alt+Insert`	Click this icon to add one of the following available tasks: Run External tool: select to run an external application. In the dialog that opens, select one or multiple applications you want to run. If it is not defined in PyCharm yet, add its definition. For more information, refer to External tools and External Tools. Run Another Configuration: select to execute another run/debug configuration and wait until it finishes before starting the current configuration. If you want to run several configurations in parallel, use a compound run/debug configuration. Launch Web Browser: select this option to have a browser started. In the dialog that opens, select the type of the browser and provide the start URL. Also, specify if you want the browser be launched with JavaScript debugger. Run File Watchers: select this option to have PyCharm apply all the currently active File Watchers. Run Grunt task: select this option to run a Grunt task. In the Grunt task dialog that opens, specify the Gruntfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Grunt tool. Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the grunt-cli package. Run gulp task: select this option to run a Gulp task. In the Gulp task dialog that opens, specify the Gulpfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Gulp tool. Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the gulp package. Run npm script: select this option to execute an npm script. In the NPM Script dialog that opens, specify the npm run/debug configuration settings. Start React Native Bundler: select this option to run the bundler automatically, as part of a running or debugging session. By default, this is done through `react-native start`. If your application uses Expo, you need to run the development server via the `start` npm task. To do that, click , then in the Configure React Native dialog, choose npm script and select start from the list. Compile TypeScript: select to run the built-in TypeScript compiler and thus make sure that all the changes you made to your TypeScript code are reflected in the generated JavaScript files. In the TypeScript Compile Settings dialog that opens, select or clear the Check errors checkbox to configure the behaviour of the compiler in case any errors are detected: If the Check errors checkbox is selected, the compiler will show all the errors and the run configuration will not start. If the Check errors checkbox is cleared, the compiler will show all the detected errors but the run configuration still will be launched. Generate CoffeeScript Source Maps: select this option to generate the source maps for your CoffeeScript sources. In the dialog that opens, specify where your CoffeeScript source files are located. Run Remote External Tool: adds a remote SSH external tool.
	`Alt+Delete`	Click this icon to remove the selected task from the list.
	`Enter`	Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
	`Alt+Up` `Alt+Down`	Click these icons to move the selected task one line up or down in the list. The tasks are performed in the order that they appear in the list.
Show this page		Select this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration.
Activate tool window		By default this checkbox is selected and the Run or the Debug tool window opens when you start the run/debug configuration. Otherwise, if the checkbox is cleared, the tool window is hidden. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing `Alt+4` or `Alt+5`.

Last modified: 25 June 2024