Setting Up Eclipse for Python / Django Development

Last modified: May 26, 2016 | Posted in Django Tutorials

Using Eclipse with PyDev as an IDE for your development on your Django project can be very helpful in many ways. Since it is integrated, the eclipse has the access to some of the compiler’s information, which means you got assistance in code writing. This includes code hinting, auto-completion, error checking, and navigating through libraries by just a single click or two. You also get to have a scheme for your code, making it easier to read.  PyDev comes with a variety of stuff you’d really love. It has Django integration, Code completion, Syntax highlighting, Code analysis, Unittest integration, Interactive console and many others to mention (see http://pydev.org).

There are four parts to this procedure. First, you need to install JDK since it is the Eclipse prerequisite. You can then proceed to installing Eclipse. Installing PyDev for eclipse is necessary so that working with Django should be on the go. And finally, test the eclipse by creating a sample project.

Installing Java Development Kit (JDK) on Ubuntu

Open a terminal and execute the following line:

sudo apt-get install openjdk-7-jdk

or you can install sunjdk. The sun jdk isn’t included in the official repository, so you need to add a PPA for that.

sudo add-apt-repository ppa:ferramroberto/java
sudo apt-get update
sudo apt-get install sun-java6-sdk sun-java6-plugin

Installing Eclipse 3.7.2 on Ubuntu

  1. Download Eclipse. You may have to select what package you want to use. Runwget <url> to download the package.
  2. Extract it.
    tar xzf eclipse-SDK-3.7-linux-gtk-x86_64.tar.gz
  3. Move to /opt/folder
    sudo mv eclipse /opt/
    sudo chown –R root:root eclipse
    sudo chmod –R +r eclipse
  4. Create an eclipse executable in your path and save the file.
    sudo touch /usr/bin/eclipse
    sudo chmod 755 /usr/bin/eclipse
    sudo nano /usr/bin/eclipse

    copy this into nano

    #!/bin/sh
    #export MOZILLA_FIVE_HOME=”/usr/lib/mozilla/”
    export ECLIPSE_HOME=”/opt/eclipse”
    
    $ECLIPSE_HOME/eclipse $*
  5. Create a gnome menu item and save the file.
    sudo nano /usr/share/applications/eclipse.desktop

    copy this into nano

                [Desktop Entry]
                Encoding=UTF-8
                Name=Eclipse
                Comment=Eclipse IDE
                Exec=eclipse
                Icon=/opt/eclipse/icon.xpm
                Terminal=false
                Type=Application
                Categories=GNOME;Application;Development;
                StartupNotify=true
  6. Launch Eclipse.
    eclipse &

[SOURCE]

Installing PyDev and PyDev Extensions

  1. To install PyDev and PyDev Extensions using the Eclipse Update Manager, you need to use the Help > Install New Software…

     tumblr_m5iwprH8Ja1qcbckf

    tumblr_m5iwry3iV31qcbckf

  2. Add the update site you want to work with by clicking the ‘Add..’ button. http://pydev.org/updates

    tumblr_m5ixpgLPzG1qcbckf

  3. Select the update site you entered and add a filter for PyDev so that it shows the contents of all the update sites that have PyDev.

    tumblr_m5ixsy7Siv1qcbckf

  4. Uncheck the ‘Contact all update sites during install to find required software’
  5. Select the two main items to install and click ‘Next’.
  6. You may read the license agreement and if you accept, select the accept radio button and click ‘Finish’.
  7. Eclipse should automatically download the plugin contents and present you to a dialog asking if you want to restart the Eclipse or not.

[SOURCE]

Using Eclipse and PyDev for Django

This procedure assumes you’ve already installed Eclipse, PyDev as well as Python and Django.

  1. Open up terminal and create a directory for your project. Move to your created directory and runvirtualenv
                $ mkdir mysite
                $ cd mysite
                $ virtualenv env
                $ cd env/
  2. Open Eclipse. Setup the Python Interpreter by clicking the ‘New…’ button. To do this, go to Windows > Preferences and on the left pane, expand PyDev and select Interpreter – Python.

    tumblr_m5iyr3uAOC1qcbckf

    tumblr_m5iytlkFt31qcbckf

  3. Select the interpreter by browsing to the bin folder of your existing virtualenv and selecting the python executable. Hit the ‘OK’ button when finished.

    tumblr_m5iywqVPP71qcbckf

  4. You need to check the /usr/lib/python2.7. Hit the ‘OK’ button when finished.

    tumblr_m5iz0qn8sJ1qcbckf

  5. Hit the ‘OK’ button when you’re done adding a Python Interpreter.

    tumblr_m5iz3kwcmt1qcbckf

  6. Create a project on Eclipse by navigating to File > New > Project or Ctrl+n. Navigate and expand the PyDev folder. Select PyDev Django Project and hit ‘Next >’button. This is equivalent to creating a project using a command line :
    $ django-admin.py startproject mysite

    tumblr_m5iz9aibna1qcbckf

  7. Fill in the Project name. Uncheck the ‘Use default’ option under Project contents and browse to the directory you created using the command virtualenv. And make sure you select the ‘Don’t configure PYTHONPATH’ option. Hit ‘Next >’ button.
    tumblr_m5izcmUCng1qcbckf
  8. Setup your database configuration.

    tumblr_m5izfgH3d21qcbckf

  9. Navigate to the Properties of your newly created project by right-clicking the root folder and selecting Properties from the context menu or simply hit Alt+Enter to bring up the Properties Window.

    tumblr_m5izhpbuho1qcbckf

  10. Select PyDev – PYTHONPATH from the left pane and in the Source Folders tab, hit the ‘Add source folder’ button. You will be asked to choose a folder from your project directory.

    tumblr_m5m4n3fCIS1qcbckf

  11. Hit the ‘OK’ button whenever you’re done adding a source folder.

    tumblr_m5m4pjLGqS1qcbckf

  12. This should have been added on your project’s PyDev – PYTHONPATH. Your project tree should look like on the image below.

    tumblr_m5m4sq5faX1qcbckf

  13. To test that this works properly, open up your urls.py file and Ctrl+Click on the patterns call – it should take you to defaults.py.
  14. To test the site, select your root directory and navigate to Run > Run on your eclipse menu or simply hit Ctrl+F11.
    tumblr_m5m5fgvLYb1qcbckf