wxPython/docs/BUILD.devel.txt

   1 Building wxPython 2.5 for Development and Testing
   2 =================================================
   3
   4 This file describes how I build wxWindows and wxPython while doing
   5 development and testing, and is meant to help other people that want
   6 to do the same thing.  I'll assume that you are using either a CVS
   7 snapshot or a checkout from CVS.  (Currently you need to use the
   8 wxPy_newswig branch of the wwxPython subtree of CVS.)  I'll also
   9 assume that you know what you are doing and so I may not be as
  10 detailed here as I am in other BUILD docs.
  11
  12 If you want to make changes to any of the *.i files, or regenerate the
  13 extension sources or renamer modules, then you will need an up to date
  14 version of SWIG.  Either get and build the current CVS version, or
  15 version 1.3.20 when it is released.  If you install this build of SWIG
  16 to a location that is not on the PATH (so it doesn't interfere with an
  17 existing SWIG install for example) then you can set a setup.py
  18 command-line variable named SWIG to be the full path name of the
  19 executable and the wxPython build will use it.  See below for an
  20 example.
  21
  22
  23
  24
  25 Building on Linux and OS X
  26 --------------------------
  27
  28 These two platforms are built almost the same way while in development
  29 so I'll combine the descriptions about their build process here.
  30 First we will build wxWindows and install it to an out of the way
  31 place, then do the same for wxPython.
  32
  33
  34 1. Create a build directory in the main wxWindows dir, and configure
  35    wxWindows.  If you want to have multiple builds with different
  36    configure options, just use different subdirectories.  I normally
  37    put the configure command in a script named ".configure" in each
  38    build dir so I can easily blow away everything in the build dir and
  39    rerun the script without having to remember the options I used
  40    before::
  41
  42          mkdir bld
  43          cd bld
  44          ../configure --prefix=/opt/wx/2.5 \
  45                       --with-gtk \
  46                       --with-opengl \
  47                       --disable-monolithic \
  48                       --enable-debug \
  49                       --enable-geometry
  50
  51
  52    On OS X of course you'll want to use --with-mac instead of
  53    --with-gtk.  For GTK2 and unicode add:
  54
  55                       --enable-gtk2 \
  56                       --enable-unicode
  57
  58    Notice that I used a prefix of /opt/wx/2.5.  You can use whatever
  59    path you want, even the standard ones if you like, but this lets me
  60    easily have multiple versions and ports of wxWindows "installed"
  61    and makes it easy to switch between them.
  62
  63
  64 2. To build and install wxWindows you could just use "make" but there
  65    are other libraries that also need to be built so again I make a
  66    script to do it all for me so I don't forget anything.  This time
  67    it is called ".make" (I use the leading ".  so when I do "rm -r *"
  68    in my build dir I don't lose my scripts too.)  This is what it
  69    looks like::
  70
  71         make $* \
  72             && make -C contrib/src/gizmos $* \
  73             && make -C contrib/src/ogl CXXFLAGS="-DwxUSE_DEPRECATED=0" $* \
  74             && make -C contrib/src/stc $* \
  75             && make -C contrib/src/xrc $*
  76
  77    So you just use .make as if it where make, but don't forget to set
  78    the execute bit on .make first!::
  79
  80          .make
  81          .make install
  82
  83    When it's done you should have an installed set of files under
  84    /opt/wx/2.5 containing just wxWindows.  Now to use this version of
  85    wxWindows you just need to add /opt/wx/2.5/bin to the PATH and set
  86    LD_LIBRARY_PATH (or DYLD_LIBRARY_PATH on OS X) to /opt/wx/2.5/lib.
  87
  88
  89 3. I also have a script to help me build wxPython and it is checked in
  90    to the CVS as wxWindows/wxPython/b, but probably don't want to use
  91    it as it's very cryptic and expects that you want to run SWIG, so
  92    if you don't have the latest patched up version of SWIG then you'll
  93    probably get stuck.  So I'll just give the raw commands instead.
  94
  95    We're not going to install the development version of wxPython with
  96    these commands, so it won't impact your already installed version
  97    of the latest release.  You'll be able test with this version when
  98    you want to, and use the installed release version the rest of the
  99    time.  If you ever do want to install the development verison just
 100    use the normal distutils commands to do it.
 101
 102    Make sure that the first wx-config found on the PATH is the one you
 103    installed above, and then change to the wxWindows/wxPython dir and
 104    run the this command::
 105
 106          cd wxPython
 107          python2.3 setup.py build_ext --inplace --debug
 108
 109    If you are building with GTK2 then add the following flags to the
 110    command line::
 111
 112          WXPORT=gtk2 UNICODE=1
 113
 114    If you are wanting to have the source files regenerated with swig,
 115    then you need to turn on the USE_SWIG flag and optionally tell it
 116    where to find the new swig executable, so add these flags::
 117
 118          USE_SWIG=1 SWIG=/opt/swig/bin/swig
 119
 120    When the setup.py command is done you should have fully populated
 121    wxPython and wx packages locally in wxWindows/wxPython/wxPython and
 122    .../wx, with all the extension modules (*.so files) located in the
 123    wx package.
 124
 125
 126 4. To run code with the development verison of wxPython, just set the
 127    PYTHONPATH to the wxPython dir in the CVS tree.  For example::
 128
 129         export LD_LIBRARY=/opt/wx/2.5/lib
 130         export PYTHONPATH=/myprojects/wxWindows/wxPython
 131         cd /myprojects/wxWindows/wxPython/demo
 132         python2.3 demo.py
 133
 134
 135
 136
 137
 138 Building on Windows
 139 -------------------
 140
 141 The Windows builds currently require the use of Microsoft Visual C++.
 142 Theoretically, other compilers (such as mingw32 or the Borland
 143 compilers) can also be used but I've never done the work to make that
 144 happen.  If you want to try that then first you'll want to find out if
 145 there are any tricks that have to be done to make Python extension
 146 modules using that compiler, and then make a few changes to setup.py
 147 to accomodate that.  (And send the patches to me.)  If you plan on
 148 using VisualStudio.Net (a.k.a. MSVC 7.1) keep in mind that you'll also
 149 have to build Python and any other extension modules that you use with
 150 that compiler because a different version of the C runtime likbrary is
 151 used.  The Python executable that comes from PythonLabs and the
 152 wxPythons that I distribute are built with MSVC 6 with all the Service
 153 Packs applied.
 154
 155 If you want to build a debugable version of wxWindows and wxPython you
 156 will need to have also built a debug version of Python and any other
 157 extension modules you need to use.  You can tell if you have them
 158 already if there is a _d in the file names, for example python_d.exe
 159 or python23_d.dll.  If you don't need to trace through the C/C++ parts
 160 of the code with the debugger then building the normal (or hybrid)
 161 version is fine, and you can use the regular python executables with
 162 it.
 163
 164 Just like the unix versions I also use some scripts to help me build
 165 wxWindows, but I use some non-standard stuff to do it.  So if you want
 166 to use them too you'll need to get a copy or 4DOS or 4NT from
 167 http://www.jpsoft.com/ and also a copy of unix-like cat and sed
 168 programs.  You can also do by hand what my scripts are doing, but
 169 there are a lof steps involved and I won't be going into details
 170 here.  There is a copy of my build scripts in wxWindows\wxPython\distrib\msw
 171
 172
 173 1. Set an environment variable to the root of the wxWindows source
 174    tree::
 175
 176          set WXWIN=e:\projects\wxWindows
 177
 178 2. Copy setup0.h to setup.h
 179
 180          cd %WXWIN%\include\wx\msw
 181          copy setup0.h setup.h
 182
 183 3. Edit setup.h and change a few settings.  Some of them are changed
 184    by my build scripts depending on the type of build (debug/hybrid,
 185    unicode/ansi). I change a few of the other defaults to have these
 186    values::
 187
 188          wxDIALOG_UNIT_COMPATIBILITY    0
 189          wxUSE_DEBUG_CONTEXT            1
 190          wxUSE_MEMORY_TRACING           1
 191          wxUSE_DIALUP_MANAGER           0
 192          wxUSE_GLCANVAS                 1
 193          wxUSE_POSTSCRIPT               1
 194          wxUSE_AFM_FOR_POSTSCRIPT       0
 195
 196
 197 4. Make a %WXWIN%\BIN directory and add it to the PATH.  My build
 198    scripts will copy the wxWindows DLLs there.
 199
 200 5. Change to the %WXWIN%\build\msw directory and copy my build scripts
 201    there.
 202
 203 6. Use the .make command to build wxWindows.  It needs one
 204    command-line parameter which controls what kind of build(s) to do.
 205    Use one of the following::
 206
 207          debug          Build debug version
 208          hybrid         Build hybrid version
 209          both           Both debug and hybrid
 210          debug-uni      Build a debug unicode library
 211          hybrid-uni     Hybrid unicode (see the pattern yet? ;-)
 212          both-uni       and finally both unicode libraries
 213
 214    For example::
 215
 216          .make hybrid
 217
 218
 219 7.  When that is done there should be a ton of DLLs in %WXDIR%\bin and
 220     lots of lib files and stuff in %WXDIR%\lib\vc_dll
 221
 222
 223 8. Building wxPython on Windows is very similar to doing it for the
 224    unix systems.  We're not going to install the development version
 225    of wxPython with these commands, so it won't impact your already
 226    installed version of the latest release.  You'll be able test with
 227    this version when you want to, and use the installed release
 228    version the rest of the time.  If you ever do want to install the
 229    development verison just use the normal distutils commands to do
 230    it.
 231
 232    Change to the wxWindows\wxPython dir and run the this command::
 233
 234          cd %WXWIN%\wxPython
 235          python setup.py build_ext --inplace
 236
 237    If you are wanting to have the source files regenerated with swig,
 238    then you need to turn on the USE_SWIG flag and optionally tell it
 239    where to find the new swig executable, so add these flags::
 240
 241          USE_SWIG=1 SWIG=e:\projects\SWIG-cvs\swig.exe
 242
 243    If you have a debug version of Python and wxWindows and want to
 244    build a debug version of wxPython too, add the --debug flag to the
 245    command line.  You should then end up with a set of *_d.pyd files
 246    in the wx package and you'll have to use python_d.exe to use them.
 247    The debug and hybrid(release) versions can coexist.
 248
 249    When the setuyp.py command is done you should have fully populated
 250    wxPython and wx packages locally in wxWindows/wxPython/wxPython and
 251    .../wx, with all the extension modules (*.pyd files) located in the
 252    wx package.
 253
 254
 255 9. To run code with the development verison of wxPython, just set the
 256    PYTHONPATH to the wxPython dir in the CVS tree.  For example::
 257
 258         set PYTHONPATH=e:\projects\wxWindows\wxPython
 259         cd e:\projects\wxWindows\wxPython
 260         python demo.py
 261