Installation Guide

Preface:

This document explains the process of installing Editra on each of the following three systems

  1. Linux
  2. Macintosh OS X
  3. Windows

The scope of the installation procedures will cover both binary and source based installations. As a general suggestion using the binary versions when available is always easier as the do not require you to install any dependancies. However if binaries are not available or you want to be running the latest version from the svn repository then a source install is the way to go.



Binary Installations:


Linux:

Currently no binaries are available

Macintosh OS X:

  1. Download the .dmg file from the Macintosh section of the downloads page.

  2. Double click on the file Editra-x.x.xx_OSX10.4_Universal.dmg where the "x" are the version number that was downloaded, to mount the disk image.

  3. There should now be a new drive icon on your desktop. Double click to open it if it did not already open automatically.

  4. Now you will see a Finder window with a single icon in the middle. Click and drag this icon from the window to the Applications Folder or to any other location you wish to keep it at.

  5. You may now unmount the disk image that was mounted by dragging it to the trash

  6. Editra is now installed. You may also optionally drag the Editra Icon to the dock to allow for easy access to it.

Windows (2000/XP):

  1. Download the .exe file from the Windows section of the downloads page.

  2. Double click on the file that was downloaded. It should be named something similar to the following, editra.win32.x.x.xx.exe, where the "x" represent the version of Editra that was downloaded.

  3. The welcome screen of the installer should now be displayed on the screen. Follow the on screen instructions to complete the installation.

  4. Editra is installed by default to C:\\Program Files\Editra. It also creates a Start Menu and Desktop link to the program, as well as an Uninstaller which can be used with the Windows Add and Remove software program.

  5. Installation is complete. You can optionally delete the installer program that was downloaded in step one at this point.



Installing From Source:


Getting Started:

Installing Dependancies

In order to use the source code version of Editra your system must have the proper dependancies installed. So please if you do not already have compatible versions of the following software installed, download them and install them now.

  1. Python 2.4 or 2.5
  2. wxPython 2.8 or higher
  3. Setuptools (only required if you wish to use plugins)

Get the Source:

Tarball or SVN

The latest "stable" source code is always available on the website as a gzipped tarball, and can be downloaded on the downloads page. This is the best starting point as this code has been verified and reviewed to work. However if you want to try the absolute latest code that has newest features and improvements, the code is available via anonymous svn. You will need to have an SVN Client installed in order to check the code out from the repository.

Issue the following svn command from the command line or the gui equivalent if you are using a graphical svn client.

    svn checkout http://svn.wxwidgets.org/svn/wx/wxPython/3rdParty/Editra Editra 

Installing:

Step by Step

Now that you have the source code its time to install. The first part of this section will discuss installing on Unix/Linux based systems (OS X included). Installing from source on Windows is discussed in part two, it is very similar to Unix/Linux bases systems installs but has a few caveats that require extra explanation so it has been given its own section.

1. Unix/Linux/Mac OSX:

  1. Open a terminal window and navigate to the source directory of Editra

  2. In the top level of the source directory is the setup.py file this is the script for building/installing Editra.

  3. If using code from SVN its a good idea to see if the code is in working order before installing it. To do this just run the launcher script from the top level directory.
    somebody@tux ~/Desktop/Editra$ python Editra
    
    or
    
    somebody@tux ~/Desktop/Editra/src$ python Editra.py
    
    If it fails to run the program then the version svn that you checked out is likely broken and you will need to either wait for a newer version of svn code or download the tarball from the downloads page.

  4. Now to install just do the usual python thing.
    somebody@tux ~/Desktop/Editra/src$ python setup.py install
    
    This will byte compile and optimize the program and then install it into the site-packages of the python version used to run the setup.py script. It will also install a program launch script on your path that is named Editra and can be used to run the program.
    somebody@tux ~/Desktop/Editra$ Editra
    

  5. Last if anything went wrong above or you ended up with an installation that cant run Editra it is a bug. So please let me know about it by posting the output of the install script and some information about your OS and python/wxpython versions to the Community Page so that I can try to fix it for future versions.

2. Windows:

The main difference of installing from source on Windows and other systems has to do with the PATH variable not being correctly configured by default. So the first step is to properly configure the path.

  1. Right Click on "My Computer" and select "Properties"
  2. Click on the "Advanced" tab of the dialog
  3. Click on the "Environmental Variables" button to open the config dialog.
  4. In the Environmental Variables config dialog click on "New" under "User Variables"
  5. Enter the following values into the dialog. Replace the "Variable Value" with the appropriate path to the installed version of python.
    Variable Name:  Path
    Variable Value: C:\Python25
    
    Then click on "Ok" to close the dialog.

Now that the Path is properly configured we can proceed to install Editra.

  1. Open up a Command Terminal and navigate to the directory that the source for Editra that was downloaded is located in.
  2. Run the following command to install Editra
    python setup.py install
    
  3. The setup.py script will install the source package into the following path relative to the version of python used to install it, (Lib\site-packages). The script used to launch and run Editra is installed to (Scripts\) which is also relative to the version of python used.
  4. If you wish to run Editra you will need to either add the Scripts directory to the Path variable like done above, or create a link to the script. This is not done automatically as it is on Unix systems