How do I install OSHIP on MS Windows (XP and Vista)?

Created by Luciana Tricai Cavalini on
Install; Installation; Windows; Windows XP; Windows Vista
Last updated by:
Tim Cook on

These instructions are out of date. OSHIP now requires Python 2.6.x Please see the installation instructions at:

Installing the OSHIP framework on MS Windows XP and Vista

*The original install guide was contributed by Alessandro Torrisi. Tim Cook and Roger Erens contributed to a earlier version of a related FAQ.*

1. Installation of Prerequisites

1.1. C compiler: we recommend MinGW. Download from

**Please Note: The Decision Support Engine (and possibly other C code) will not compile with this C compiler. You may need Visual Studio since Python for Windows was compiled with Visual Studio. There may be a work around using CygWin but we do not yet have details. Any help from Windows users?

1.2. Python 2.5 (tested with version 2.5.4): OSHIP requires at least Python 2.5; if it is not already installed on your system, you can download an installer from .
1.3. Win32API files: download from for Python 2.5
1.4. Bazaar client: download from
1.5. Executable setuptools from the Python Package Index: download fro The file to be downloaded is setuptools-0.6c9.win32-py2.5.exe

2. Adding the Python binary to the environment variable PATH

2.1. We assume that Python is installed for all users in the default directory "C:\Python25"
2.2. Go to "Control Panel"
2.3. Go to "System"
2.4. Go to "Advanced"
2.5. Go to "Environment variables"
2.6. Go to the list of "System Variables"
2.7. Find the variable "Path"
2.8. Click on "Edit"
2.9. On the "Variable Values" field, go to the end and add ";C:\Python25;C:\Python25\Scripts"
2.10. OK, OK and OK


3. Creating a virtual environment

3.1. Open a command window
3.2. Type "easy_install virtualenv"
3.3. Check if the directory "C:\Python25\Scripts" now contains the file "virtualenv.exe"
3.4. Close the command window

4. Installation steps

4.1. Open a new command window
4.2. We assume that we start in the root folder "C:\". Then type "virtualenv --no-site-packages oshipenv"
4.3. Type "cd oshipenv"
4.4. Type "Scripts\activate.bat"
4.5. Check that your system prompt is now prefixed with "(oshipenv)" (e.g. "(oshipenv) C:\oshipenv>")
4.6. Install the buildout-machinery: type "easy_install zc.buildout"
4.7. Obtain the latest stable OSHIP source tree: type "bzr branch lp:~oship-mgmt/oship/stable"
4.8. Go to the directory where buildout.cfg is (e.g. "C:\oshipenv\oship\oship")
4.9. Type "edit buildout.cfg"
4.10. Uncomment the line (by removing the "#" symbol): "eggs-directory = C:\shared-eggs" and save the file

**Note that this creates a problem for Windows users that want to commit code back to a branch because this will not be a changed, versioned file. The Windows users MUST remember to re-add the comment before commiting their code each time. I'm sure tht there is a better way. Windows users?????

4.11. Create the directory "C:\shared-eggs"
4.12. Go to the directory where the file "" is (e.g. "C:\oshipenv\oship\oship")
4.13. Type "python"
*Note: sometimes, you need to repeat this step. It is complete when the last line of the prompt text says "now you can run buildout".
4.14. Type "bin\buildout"
4.15. Type "bin\paster serve parts\etc\deploy.ini"
4.16. When the message from the above command says "Serving on", go to your web browser and type "http://localhost:8080"
4.17. The default username and password are "admin"
4.18. On the Grok application interface, under "Add application", "", type "oship" on the "Name your new app" field and click on "Create"
4.19. On "Installed applications", click on "oship(oship)"
4.20. You will be directed to the OSHIP management page. Have fun!