wxPython/docs/INSTALL.html

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   6 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
   7 <title>Installing wxPython 2.8 from Source</title>
   8 <link rel="stylesheet" href="default.css" type="text/css" />
   9 </head>
  10 <body>
  11 <div class="document" id="installing-wxpython-2-8-from-source">
  12 <h1 class="title">Installing wxPython 2.8 from Source</h1>
  13 <p>This document will describe the few differences and additions to the
  14 content in the <a class="reference" href="BUILD.html">BUILD</a> document for installing wxPython built from
  15 source.  Please follow the intstructions both in this file and in
  16 <a class="reference" href="BUILD.html">BUILD</a> to perform this task.  Where there is overlap the items
  17 described here will take precedence for doing installations.</p>
  18 <div class="section">
  19 <h1><a id="installing-on-unix-like-systems-not-os-x" name="installing-on-unix-like-systems-not-os-x">Installing on Unix-like Systems (not OS X)</a></h1>
  20 <ol class="arabic">
  21 <li><p class="first">When building wxWidgets you need to decide if you want it to be a
  22 private copy only accessed by wxPython, or if you would like it to
  23 be installed in a stanard location such as /usr.  Or perhaps you
  24 already have a version of wxWidgets installed on your system (such
  25 as from an RPM) and you want wxPython to use that version too.  If
  26 so then you'll want to ensure that the flags and options used to
  27 build the installed version are compatible with wxPython.</p>
  28 </li>
  29 <li><p class="first">If you do decide to build and install your own wxWidgets then there
  30 are a few tweaks to the configure flags described in BUILD.txt that
  31 you will probably want to make.  Instead of --enable-debug use
  32 this configure flag:</p>
  33 <pre class="literal-block">
  34 --enable-optimize \
  35 </pre>
  36 <p>Normally I also use the following flag in order to have wxWidgets
  37 runtime assertions turned into Python exceptions where possible.
  38 It does add extra code to the build but probably not enough to
  39 worry about it.  However if you want to get as lean a build as
  40 possible you can leave it out, but if your code does something bad
  41 then instead of exceptions you'll likely get a crash:</p>
  42 <pre class="literal-block">
  43 --enable-debug_flag \
  44 </pre>
  45 <p>If you are building a private copy of wxWidgets (IOW, not installed
  46 in a standard library location) then it can be kind of a hassle to
  47 always have to set the LD_LIBRARY_PATH variable so wxPython can
  48 find the wxWidgets shared libraries.  You can hard code the library
  49 path into the binaries by using the rpath option when configuring
  50 wxWidgets.  For example:</p>
  51 <pre class="literal-block">
  52 --enable-rpath=/opt/wx/2.8/lib \
  53 </pre>
  54 <p>SOLARIS NOTE: The --enable-rpath option may cause problems when
  55 using wxGTK on Solaris when compiling wxPython as described below.
  56 The woraround is to not use --enable-rpath flag for configure, but
  57 in that case all wxPython applications <em>must</em> have the
  58 LD_LIBRARY_PATH set to include $WXPREF/lib, or you can use the
  59 'crle' program to modify the runtime linking environment.  If this
  60 is the only installation of wxGTK on the system then you can use a
  61 system library path for prefix and not have to worry about it at
  62 all.</p>
  63 </li>
  64 <li><p class="first">Build and install wxGTK as described in BUILD.txt.</p>
  65 </li>
  66 <li><p class="first">In addition to building wxPython as described in BUILD.txt, you can
  67 install it to Python's site-packages dir, as well as some scripts
  68 into the same bin dir used by Python by using this command, plus
  69 whatever WXPORT, UNICODE, etc. settings you used for the initial
  70 build step:</p>
  71 <pre class="literal-block">
  72 python2.5 setup.py install
  73 </pre>
  74 <p>If you would like to install to some place besides the prefix where
  75 Python is installed, (such as to your home directory) then you can
  76 add &quot;--root=&lt;path&gt;&quot; after the &quot;install&quot; command.  This will use
  77 &lt;path&gt; as the prefix and will install scripts to a bin subdir and
  78 the wxPython packages to a lib subdir.  To use wxPython like this
  79 you'll need to ensure that the directory containing wxPython is
  80 contained in the PYTHONPATH environment variable.</p>
  81 </li>
  82 </ol>
  83 </div>
  84 <div class="section">
  85 <h1><a id="installing-on-os-x" name="installing-on-os-x">Installing on OS X</a></h1>
  86 <p>Installing wxPython on OS X is nearly the same as the Unix
  87 instructions above, except for a few small, but important details:</p>
  88 <ol class="arabic simple">
  89 <li>The --enable-rpath configure option is not needed since the path to
  90 the wxWidgets dylibs will automatically be encoded into the
  91 extension modules when they are built.  If you end up moving the
  92 wxWidgets dynlibs to some other location (such as inside the .app
  93 bundle of your applicaiton for distribution to other users,) then
  94 you will need to set DYLD_LIBRARY_PATH to this location so the
  95 dylibs can be found at runtime.</li>
  96 <li>Depending on the version of OS X Python may be installed in
  97 different locations.  On 10.2 (Jaguar) you need to download and
  98 install MacPython-OSX-2.3 from <a class="reference" href="http://www.python.org/">http://www.python.org/</a> and the
  99 Python Framework will then be installed in /Library/Frameworks.  On
 100 10.3 (Panther) Apple supplies the Python Framework as part of the
 101 OS install, but it will be located in /System/Library/Frameworks
 102 instead.  However, on Panther the site-packages dir is sym-linked
 103 to /Library/Python/2.3 so the wxPython packages will end up there,
 104 although they will still be visible from site-packages.  If you are
 105 building distributions of wxPython to be installed on other
 106 machines be careful to install to /Library/Python/2.3.  To
 107 complicate things further, the Jaguar version, or a custom build
 108 you do yourself will end up in /Library/Frameworks even on
 109 Panther...</li>
 110 <li>You need to use pythonw at the command line or the PythonLauncher
 111 app to run wxPython apps, otherwise the app will not be able to
 112 fully use the GUI display.</li>
 113 </ol>
 114 </div>
 115 <div class="section">
 116 <h1><a id="installing-on-windows" name="installing-on-windows">Installing on Windows</a></h1>
 117 <ol class="arabic">
 118 <li><p class="first">Build wxWidgets and wxPython as described in BUILD.txt.  If you
 119 would rather have a version without the code that turns runtime
 120 assertions into Python exceptions, then use &quot;release&quot; instead of
 121 &quot;hybrid&quot; when building wxWidgets and add &quot;FINAL=1&quot; to the setup.py
 122 command line.</p>
 123 </li>
 124 <li><p class="first">Install wxPython like this.  Remember to add any additional flags
 125 you added for the build such as UNICODE or USE_SWIG:</p>
 126 <pre class="literal-block">
 127 python setup.py install
 128 </pre>
 129 </li>
 130 <li><p class="first">Copy the wxWidgets DLLs to the wx package directory so they can be
 131 found at runtime by the extension modules without requiring that
 132 they be installed on the PATH:</p>
 133 <pre class="literal-block">
 134 copy %WXWIN%\\lib\\vc_dll\\wx*h_*.dll c:\\Python25\\Lib\\site-packages\\wx
 135 </pre>
 136 </li>
 137 </ol>
 138 </div>
 139 </div>
 140 </body>
 141 </html>