To get started with Django in PyDev, the pre-requisite is that Django is installed in the Python / Jython / IronPython interpreter you want to use (so, "import django" must properly work – if you're certain that Django is there and PyDev wasn't able to find it during the install process, you must go to the interpreter configuration and reconfigure your interpreter so that PyDev can detect the change you did after adding Django).
If you don't have Django installed, follow the steps from http://www.djangoproject.com/.
Note that this tutorial won't teach you Django. It'll only show how the Django integration is available in PyDev, so, if you're not familiar with Django, it's useful to learn a bit about how it works and then use this help to know how the PyDev Django integration can help you.
A bit on internals
The Django integration in PyDev works through 3 main configurations:
1. The project must be marked as a Django project inside of PyDev.
2. A DJANGO_MANAGE_LOCATION string substitution variable must point to the project-relative location of manage.py.
3. A DJANGO_SETTINGS_MODULE string substitution variable must contain the name of the settings module in that project.
And that's it, with those properly configured, all the Django-related actions should work (provided the project is already configured as a Django project, there's an UI to configure those settings in the project properties: right-click your project > properties > PyDev - Django)
Creating a new project
Use the new project wizard through Ctrl+N > PyDev Django Project to create a new Django based project.
That wizard will use django-admin.py startproject to create the project and will properly set the string substitution variables used inside of PyDev so that DJANGO_MANAGE_LOCATION points to the created manage.py location and the DJANGO_SETTINGS_MODULE points to the settings module.
Using the Django integration in an existing project
For an existing project, just right click it and choose 'PyDev > Set as Django project'.
Note that the DJANGO_MANAGE_LOCATION and DJANGO_SETTINGS_MODULE will not be set at this time, but when executing an action that needs it, PyDev will ask about it.
Django actions can be accessed right clicking a project with the Django configuration and choosing Django > action.
Another option is using (with focus on a PyDev editor):
- ctrl+2+dj <enter> to open a dialog with the history of entered actions
- ctrl+2+dj action_to_execute <enter> to already pass the action to be executed (e.g.: ctrl+2+dj help <enter>)
Interactive shell with Django
Note that the Shell with django environment action will create a shell properly configured with your settings, providing the default features from the PyDev shell, such as code completion, history, context assistants (ctrl+1), making an execfile of the editor, etc (see: Interactive Console for more details).
It can be activated through ctrl+2+dj shell (if on a PyDev Editor) or right-clicking the project > Django > Shell with django environment.
Run/Debug as Django
Run as Django/Debug as Django are available (note that they set the --noreload by default).
This will create a default Run configuration, so, you may edit it later through run > run configurations (or debug > debug configurations) if you want to change a parameter.
Note: to know how to rerun the last launch see: the Rerun Last Launch topic on PyDev Launching
Note 2: if the --noreload is not passed, only the parent process will be killed from Eclipse and the others will only be killed when they'd be reloaded (i.e.: on a code-change).
Run Django with autoreload
It's possible to run Django using it's auto-reload feature, but as stated above, doing so by default will have a bad side effect in which it'll actually leave spawned processes alive in the auto-reload. A workaround is provided by doing:
just before the if _name_ == "_main_": in your manage.py module.
This will make the spawned children processes have their own console outside of Eclipse, where Ctrl+C may be properly used to kill the Django process (don't forget to remove the --noreload that PyDev added automatically to the launch configuration).
Debug Django with autoreload
To debug Django with the autoreload feature, the Remote Debugger must be used and a patch must be applied to your code (just before the if _name_ == "_main_": in your manage.py module):
So, doing that, starting the remote debugger and making a regular run should enable all the regular breakpoints that are put inside Eclipse to work in the Django process with the Remote Debugger (don't forget to remove the --noreload that PyDev added automatically to the launch configuration).