PlanerDevelopment

pLANer Development

Overview

To build and run pLANer, you need to install a few things. pLANer is developed in Python using the PyDev plugin for Eclipse. It also uses the Twisted networking library and also Python 2.7. Finally, you must connect to the GIT repository to pull the existing code base. To install all of these things, follow the guides below.

Pulling the GIT Repository

1. Verify you have GIT installed (download at http://code.google.com/p/msysgit/)
2. Open the GIT shell
3. CD to a directory where you want to put pLANer (ex. "cd C:\planer")
4. type git clone ssh://<your-sourcecforge-username>@git.code.sf.net/p/planer/code planer-code</your-sourcecforge-username>

Installing Python 2.7

1. Navigate to http://www.python.org/getit/releases/2.7/ in your web browser
2. Download the installer appropriate for your operating system
3. Follow the instructions in the installer and remember where you install it to

Installing Eclipse

1. Navigate to http://www.eclipse.org/downloads/ in your web browser
2. Download Eclipse Classic (Either 32 or 64 bit depending on your OS)
3. Install Eclipse, following the instructions provided

Installing the PyDev plugin

1. Open Eclipse
2. Click Help->Install New Software...
3. Click Add
4. Enter "Pydev" in the Name textbox and "http://pydev.org/updates" in the Location textbox.
5. Press OK
6. Check the box next to PyDev in the list of components that is displayed
7. Press Next and then Next again
8. Check "I accept the terms of the license agreements" and press Finish
9. PyDev will then be downloaded and installed
10. When complete, go to Window->Preferences
11. Click on PyDev in the list on the left
12. Click on Python Interpreter
13. Click New
14. Enter "Python 2.7" for the name and put the path to your Python 2.7 executable in the Interpreter textbox.
15. Press OK and then Apply

Installing Twisted

Before installing Twisted, you need the Python Setup Tools

1. Navigate to http://pypi.python.org/pypi/setuptools#files in your web browser
2. Download the setuptools-0.6c11.win32-py2.7.exe option
3. Run and follow all the instructions in the installer

You also need the Zope interface before installing Twisted

1. Navigate to http://pypi.python.org/pypi/zope.interface/3.8.0#downloads in your web browser
2. Download zope.interface-3.8.0-py2.7-win32.egg file
3. Open Command Prompt
4. cd to the <python2.7 directory="">/Scripts</python2.7>
5. Type easy_install <path-to-downloaded-zope-interface-file></path-to-downloaded-zope-interface-file>

Lastly, we can install Twisted

1. Navigate to http://twistedmatrix.com/trac/wiki/Downloads in your web browser
2. Install the appropriate .exe for your OS and Python 2.7
3. Run it and follow all instructions

Running pLANer from Eclipse

1. Open Eclipse
2. Open StartServer.py or StartClient.py
3. Click the Run button

That's it! You now have a pLANer development environment.