wxPython/docs/BUILD.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.3.7: http://docutils.sourceforge.net/" />
   7 <title>Building wxPython 2.6 for Development and Testing</title>
   8 <link rel="stylesheet" href="default.css" type="text/css" />
   9 </head>
  10 <body>
  11 <div class="document" id="building-wxpython-2-6-for-development-and-testing">
  12 <h1 class="title">Building wxPython 2.6 for Development and Testing</h1>
  13 <p>This file describes how I build wxWidgets and wxPython while doing
  14 development and testing, and is meant to help other people that want
  15 to do the same thing.  I'll assume that you are using either a CVS
  16 snapshot from <a class="reference" href="http://wxWidgets.org/snapshots/">http://wxWidgets.org/snapshots/</a>, a checkout from CVS, or
  17 one of the released wxPython-src-2.6.* tarballs.  I'll also assume that
  18 you know your way around your system, the compiler, etc. and most
  19 importantly, that you know what you are doing!  ;-)</p>
  20 <p>If you want to also install the version of wxPython you build to be in
  21 your site-packages dir and be your default version of wxPython, then a
  22 few additional steps are needed, and you may want to use slightly
  23 different options.  See the <a class="reference" href="INSTALL.html">INSTALL</a> document for more details.  If
  24 you only use the instructions in this <a class="reference" href="BUILD.html">BUILD</a> document file then you
  25 will end up with a separate installation of wxPython and you can
  26 switch back and forth between this and the release version that you
  27 may already have installed.</p>
  28 <p>If you want to make changes to any of the <tt class="docutils literal"><span class="pre">*.i</span></tt> files, (SWIG
  29 interface definition files,) or to regenerate the extension sources or
  30 renamer modules, then you will need an up to date version of SWIG,
  31 plus some patches.  Get the sources for version 1.3.24, and then apply
  32 the patches in wxPython/SWIG and then build SWIG like normal.  See the
  33 README.txt in the wxPython/SWIG dir for details about each patch and
  34 also info about those that may already have been applied to the SWIG
  35 sources.  If you install this build of SWIG to a location that is not
  36 on the PATH (so it doesn't interfere with an existing SWIG install for
  37 example) then you can set a setup.py command-line variable named SWIG
  38 to be the full path name of the executable and the wxPython build will
  39 use it.  See below for an example.</p>
  40 <p>In the text below I'll use WXDIR with environment variable syntax
  41 (either $WXDIR or %WXDIR%) to refer to the top level directory where
  42 your wxWidgets and wxPython sources are located.  It will equate to
  43 whereever you checked out the wxWidgets module from CVS, or untarred
  44 the wxPython-src tarball to.  You can either substitute the $WXDIR text
  45 below with your actual dir, or set the value in the environment and
  46 use it just like you see it below.</p>
  47 <p>If you run into what appears to be compatibility issues between
  48 wxWidgets and wxPython while building wxPython, be sure you are using
  49 the wxWidgets sources included with the wxPython-src tarball or the
  50 CVS snapshot, and not a previously installed version or a version
  51 installed from one of the standard wxWidgets installers.  With the
  52 &quot;unstable&quot; releases (have a odd-numbered minor release value, where
  53 the APIs are allowed to change) there are often significant
  54 differences between the W.X.Y release of wxWidgets and the W.X.Y.Z
  55 release of wxPython.</p>
  56 <div class="section" id="building-on-unix-like-systems-e-g-linux-and-os-x">
  57 <h1><a name="building-on-unix-like-systems-e-g-linux-and-os-x">Building on Unix-like Systems (e.g. Linux and OS X)</a></h1>
  58 <p>These platforms are built almost the same way while in development
  59 so I'll combine the descriptions about their build process here.
  60 First we will build wxWidgets and install it to an out of the way
  61 place, then do the same for wxPython.</p>
  62 <ol class="arabic">
  63 <li><p class="first">Create a build directory in the main wxWidgets dir, and configure
  64 wxWidgets.  If you want to have multiple builds with different
  65 configure options, just use different subdirectories.  I normally
  66 put the configure command in a script named &quot;.configure&quot; in each
  67 build dir so I can easily blow away everything in the build dir and
  68 rerun the script without having to remember the options I used
  69 before:</p>
  70 <pre class="literal-block">
  71 cd $WXDIR
  72 mkdir bld
  73 cd bld
  74 ../configure --prefix=/opt/wx/2.6 \
  75              --with-gtk \
  76              --with-gnomeprint \
  77              --with-opengl \
  78              --enable-debug \
  79              --enable-geometry \
  80              --enable-sound --with-sdl \
  81              --enable-display \
  82              --disable-debugreport \
  83 </pre>
  84 <p>On OS X of course you'll want to use --with-mac instead of
  85 --with-gtk and --with-gnomeprint.</p>
  86 <p><strong>NOTE</strong>: Due to a recent change there is currently a dependency
  87 problem in the multilib builds of wxWidgets on OSX, so I have
  88 switched to using a monolithic build.  That means that all of the
  89 core wxWidgets code is placed in in one shared library instead of
  90 several.  wxPython can be used with either mode, so use whatever
  91 suits you on Linux and etc. but use monolithic on OSX.  To switch
  92 to the monolithic build of wxWidgets just add this configure flag:</p>
  93 <pre class="literal-block">
  94 --enable-monolithic \
  95 </pre>
  96 <p>By default GTK 2.x will be used for the build.  If you would rather
  97 use GTK 1.2.x for some reason then you can force configure to use
  98 it by changing the --with-gtk flag to specify it like this:</p>
  99 <pre class="literal-block">
 100 --with-gtk=1 \
 101 </pre>
 102 <p>To make the wxWidgets build be unicode enabled (strongly
 103 recommended if you are building with GTK2) then add the following.
 104 When wxPython is unicode enabled then all strings that are passed
 105 to wx functions and methods will first be converted to unicode
 106 objects, and any 'strings' returned from wx functions and methods
 107 will actually be unicode objects.:</p>
 108 <pre class="literal-block">
 109 --enable-unicode \
 110 </pre>
 111 <p>Notice that I used a prefix of /opt/wx/2.6.  You can use whatever
 112 path you want, such as a path in your HOME dir or even one of the
 113 standard prefix paths such as /usr or /usr/local if you like, but
 114 using /opt this way lets me easily have multiple versions and ports
 115 of wxWidgets &quot;installed&quot; and makes it easy to switch between them,
 116 without impacting any versions of wxWidgets that may have been
 117 installed via an RPM or whatever.  For the rest of the steps below
 118 be sure to also substitute &quot;/opt/wx/2.6&quot; with whatever prefix you
 119 choose for your build.</p>
 120 <p>If you want to use the image and zlib libraries included with
 121 wxWidgets instead of those already installed on your system, (for
 122 example, to reduce dependencies on 3rd party libraries) then you
 123 can add these flags to the configure command:</p>
 124 <pre class="literal-block">
 125 --with-libjpeg=builtin \
 126 --with-libpng=builtin \
 127 --with-libtiff=builtin \
 128 --with-zlib=builtin \
 129 </pre>
 130 </li>
 131 <li><p class="first">To build and install wxWidgets you could just use the &quot;make&quot;
 132 command but there are other libraries besides the main wxWidgets
 133 libs that also need to be built so again I make a script to do it
 134 all for me so I don't forget anything.  This time it is called
 135 &quot;.make&quot; (I use the leading &quot;.&quot;  so when I do <tt class="docutils literal"><span class="pre">rm</span> <span class="pre">-r</span> <span class="pre">*</span></tt> in my build
 136 dir I don't lose my scripts too.)  This is what it looks like:</p>
 137 <pre class="literal-block">
 138 make $* \
 139     &amp;&amp; make -C contrib/src/animate $* \
 140     &amp;&amp; make -C contrib/src/gizmos $* \
 141     &amp;&amp; make -C contrib/src/stc $*
 142 </pre>
 143 <p>So you just use .make as if it where make, but don't forget to set
 144 the execute bit on .make first!:</p>
 145 <pre class="literal-block">
 146 .make
 147 .make install
 148 </pre>
 149 <p>When it's done you should have an installed set of files under
 150 /opt/wx/2.6 containing just wxWidgets.  Now to use this version of
 151 wxWidgets you just need to add /opt/wx/2.6/bin to the PATH and set
 152 LD_LIBRARY_PATH (or DYLD_LIBRARY_PATH on OS X) to /opt/wx/2.6/lib.</p>
 153 </li>
 154 <li><p class="first">I also have a script to help me build wxPython and it is checked in
 155 to the CVS as wxWidgets/wxPython/b, but you probably don't want to
 156 use it as it's very cryptic and expects that you want to run SWIG,
 157 so if you don't have the latest patched up version of SWIG then
 158 you'll probably get stuck.  So I'll just give the raw commands
 159 instead.</p>
 160 <p>We're not going to install the development version of wxPython with
 161 these commands, so it won't impact your already installed version
 162 of the latest release.  You'll be able test with this version when
 163 you want to, and use the installed release version the rest of the
 164 time.  If you want to install the development version please read
 165 INSTALL.txt.</p>
 166 <p>If you have more than one version of Python on your system then be
 167 sure to use the version of Python that you want to use when running
 168 wxPython programs to run the setup.py commands below.  I'll be
 169 using python2.3.</p>
 170 <p>Make sure that the first wx-config found on the PATH is the one you
 171 installed above, and then change to the $WXDIR/wxPython dir and
 172 run the this command:</p>
 173 <pre class="literal-block">
 174 cd $WXDIR/wxPython
 175 python2.3 setup.py build_ext --inplace --debug
 176 </pre>
 177 <p>If your new wx-config script is not on the PATH, or there is some
 178 other version of it found first, then you can add this to the
 179 command line to ensure your new one is used instead:</p>
 180 <pre class="literal-block">
 181 WX_CONFIG=/opt/wx/2.6/bin/wx-config
 182 </pre>
 183 <p>By default setup.py will assume that you built wxWidgets to use
 184 GTK2.  If you built wxWidgets to use GTK 1.2.x then you should add
 185 this flag to the command-line:</p>
 186 <pre class="literal-block">
 187 WXPORT=gtk
 188 </pre>
 189 <p>If you would like to do a Unicode enabled build (all strings sent
 190 to or retruned from wx functions are Unicode objects) and your
 191 wxWidgets was built with unicode enabled then add this flag:</p>
 192 <pre class="literal-block">
 193 UNICODE=1
 194 </pre>
 195 <p>If you are wanting to have the source files regenerated with swig,
 196 then you need to turn on the USE_SWIG flag and optionally tell it
 197 where to find the new swig executable, so add these flags:</p>
 198 <pre class="literal-block">
 199 USE_SWIG=1 SWIG=/opt/swig/bin/swig
 200 </pre>
 201 <p>If you get errors about being unable to find libGLU, wxGLCanvas
 202 being undeclared, or something similar then you can add
 203 BUILD_GLCANVAS=0 to the setup.py command line to disable the
 204 building of the glcanvas module.</p>
 205 <p>When the setup.py command is done you should have fully populated
 206 wxPython and wx packages locally in $WXDIR/wxPython/wxPython and
 207 $WXDIR/wxPython/wx, with all the extension modules (<tt class="docutils literal"><span class="pre">*.so</span></tt> files)
 208 located in the wx package.</p>
 209 </li>
 210 <li><p class="first">To run code with the development version of wxPython, just set the
 211 PYTHONPATH to the wxPython dir located in the source tree.  For
 212 example:</p>
 213 <pre class="literal-block">
 214 export LD_LIBRARY_PATH=/opt/wx/2.6/lib
 215 export PYTHONPATH=$WXDIR/wxPython
 216 cd $WXDIR/wxPython/demo
 217 python2.3 demo.py
 218 </pre>
 219 <p>OS X NOTE: You need to use &quot;pythonw&quot; on the command line to run
 220 wxPython applications.  This version of the Python executable is
 221 part of the Python Framework and is allowed to interact with the
 222 display.  You can also double click on a .py or a .pyw file from
 223 the finder (assuming that the PythonLauncher app is associated with
 224 these file extensions) and it will launch the Framework version of
 225 Python for you.  For information about creating Applicaiton Bundles
 226 of your wxPython apps please see the wiki and the mail lists.</p>
 227 <p>SOLARIS NOTE: If you get unresolved symbol errors when importing
 228 wxPython and you are running on Solaris and building with gcc, then
 229 you may be able to work around the problem by uncommenting a bit of
 230 code in config.py and building again.  Look for 'SunOS' in config.py
 231 and uncomment the block containing it.  The problem is that Sun's ld
 232 does not automatically add libgcc to the link step.</p>
 233 </li>
 234 </ol>
 235 </div>
 236 <div class="section" id="building-on-windows">
 237 <h1><a name="building-on-windows">Building on Windows</a></h1>
 238 <p>The Windows builds currently require the use of Microsoft Visual C++.
 239 Theoretically, other compilers (such as mingw32 or the Borland
 240 compilers) can also be used but I've never done the work to make that
 241 happen.  If you want to try that then first you'll want to find out if
 242 there are any tricks that have to be done to make Python extension
 243 modules using that compiler, and then make a few changes to setup.py
 244 to accommodate that.  (And send the patches to me.)  If you plan on
 245 using VisualStudio.Net (a.k.a. MSVC 7.1) keep in mind that you'll also
 246 have to build Python and any other extension modules that you use with
 247 that compiler because a different version of the C runtime library is
 248 used.  The Python executable that comes from PythonLabs and the
 249 wxPython extensions that I distribute are built with MSVC 6 with all
 250 the Service Packs applied.  This policy will change with Python 2.4
 251 and MSVC 7.1 will be used starting with that version.</p>
 252 <p>If you want to build a debuggable version of wxWidgets and wxPython you
 253 will need to have also built a debug version of Python and any other
 254 extension modules you need to use.  You can tell if you have them
 255 already if there is a _d in the file names, for example python_d.exe
 256 or python23_d.dll.  If you don't need to trace through the C/C++ parts
 257 of the code with the debugger then building the normal (or hybrid)
 258 version is fine, and you can use the regular python executables with
 259 it.</p>
 260 <p>Starting with 2.5.3.0 wxPython can be built for either the monlithic
 261 or the multi-lib wxWidgets builds.  (Monolithic means that all the
 262 core wxWidgets code is in one DLL, and multi-lib means that the core
 263 code is divided into multiple DLLs.)  To select which one to use
 264 specify the MONOLITHIC flag for both the wxWidgets build and the
 265 wxPython build as shown below, setting it to either 0 or 1.</p>
 266 <p>Just like the unix versions I also use some scripts to help me build
 267 wxWidgets, but I use some non-standard stuff to do it.  So if you have
 268 bash (cygwin or probably MSYS too) or 4NT plus unix-like cat and sed
 269 programs then there is a copy of my wxWidgets build scripts in
 270 %WXDIR%\wxPython\distrib\msw.  Just copy them to
 271 %WXDIR%\build\msw and you can use them to do your build, otherwise
 272 you can do everything by hand as described below.  But if you do work
 273 by hand and something doesn't seem to be working correctly please
 274 refer to the build scripts to see what may need to be done
 275 differently.</p>
 276 <p>The *.btm files are for 4NT and the others are for bash.  They are:</p>
 277 <pre class="literal-block">
 278 .make/.make.btm        Builds the main lib and the needed contribs
 279 .mymake/.mymake.btm    Builds just one lib, use by .make
 280 .makesetup.mk          A makefile that will copy and edit setup.h
 281                        as needed for the different types of builds
 282 </pre>
 283 <p>Okay.  Here's what you've been waiting for, the instructions!  Adapt
 284 accordingly if you are using the bash shell.</p>
 285 <ol class="arabic">
 286 <li><p class="first">Set an environment variable to the root of the wxWidgets source
 287 tree.  This is used by the makefiles:</p>
 288 <pre class="literal-block">
 289 set WXWIN=%WXDIR%
 290 </pre>
 291 </li>
 292 <li><p class="first">Copy setup0.h to setup.h:</p>
 293 <pre class="literal-block">
 294 cd %WXDIR%\include\wx\msw
 295 copy setup0.h setup.h
 296 </pre>
 297 </li>
 298 <li><p class="first">Edit %WXDIR%\include\wx\msw\setup.h and change a few settings:</p>
 299 <pre class="literal-block">
 300 wxDIALOG_UNIT_COMPATIBILITY    0
 301 wxUSE_DEBUG_CONTEXT            1
 302 wxUSE_MEMORY_TRACING           1
 303 wxUSE_DIALUP_MANAGER           0
 304 wxUSE_GLCANVAS                 1
 305 wxUSE_POSTSCRIPT               1
 306 wxUSE_AFM_FOR_POSTSCRIPT       0
 307 wxUSE_DISPLAY                  1
 308 wxUSE_DEBUGREPORT              0
 309 </pre>
 310 <p>If you are using my build scripts then a few more settings will be
 311 changed and then a copy of setup.h is placed in a subdir of
 312 %WXWIN%\libvc_dll.  If you are doing it by hand and making a
 313 UNICODE build, then also change these:</p>
 314 <pre class="literal-block">
 315 wxUSE_UNICODE                  1
 316 wxUSE_UNICODE_MSLU             1
 317 </pre>
 318 <p>If you are doing a &quot;hybrid&quot; build (which is the same as the
 319 binaries that I release) then also change these:</p>
 320 <pre class="literal-block">
 321 wxUSE_MEMORY_TRACING           0
 322 wxUSE_DEBUG_CONTEXT            0
 323 </pre>
 324 </li>
 325 <li><p class="first">Make sure that %WXDIR%\lib\vc_dll directory is on the PATH.  The
 326 wxWidgets DLLs will end up there as part of the build and so you'll
 327 need it on the PATH for them to be found at runtime.</p>
 328 </li>
 329 <li><p class="first">Change to the %WXDIR%\build\msw directory</p>
 330 <blockquote>
 331 <p>cd %WXDIR%\build\msw</p>
 332 </blockquote>
 333 </li>
 334 <li><p class="first">If using my scripts then use the .make.btm command to build
 335 wxWidgets.  It needs one command-line parameter which controls what
 336 kind of build(s) to do.  Use one of the following:</p>
 337 <pre class="literal-block">
 338 debug          Build debug version
 339 hybrid         Build hybrid version
 340 both           Both debug and hybrid
 341 debug-uni      Build a debug unicode library
 342 hybrid-uni     Hybrid unicode (see the pattern yet? ;-)
 343 both-uni       and finally both unicode libraries
 344 </pre>
 345 <p>For example:</p>
 346 <pre class="literal-block">
 347 .make hybrid
 348 </pre>
 349 <p>You can also pass additional command line parameters as needed and
 350 they will all be passed on to the nmake commands, for example to
 351 clean up the build:</p>
 352 <pre class="literal-block">
 353 .make hybrid clean
 354 </pre>
 355 <p>If <em>not</em> using my scripts then you can do it by hand by directly
 356 executing nmake with a bunch of extra command line parameters.
 357 The base set are:</p>
 358 <pre class="literal-block">
 359 nmake -f makefile.vc OFFICIAL_BUILD=1 SHARED=1 MONOLITHIC=1 USE_OPENGL=1
 360 </pre>
 361 <p>If doing a debug build then add:</p>
 362 <pre class="literal-block">
 363 BUILD=debug
 364 </pre>
 365 <p>otherwise add these:</p>
 366 <pre class="literal-block">
 367 DEBUG_FLAG=1 CXXFLAGS=/D__NO_VC_CRTDBG__ WXDEBUGFLAG=h BUILD=release
 368 </pre>
 369 <p>If doing a Unicode build then add these flags:</p>
 370 <pre class="literal-block">
 371 UNICODE=1 MSLU=1
 372 </pre>
 373 <p>Now, from the %WXDIR%\build\msw directory run nmake with your
 374 selection of command-line flags as described above.  Repeat this
 375 same command from the following directories in order to build the
 376 contrib libraries:</p>
 377 <pre class="literal-block">
 378 %WXDIR%\contrib\build\animate
 379 %WXDIR%\contrib\build\gizmos
 380 %WXDIR%\contrib\build\stc
 381 </pre>
 382 </li>
 383 <li><p class="first">When that is all done it will have built the main wxWidgets DLLs
 384 and also some of the contribs DLLs.  There should be a ton of DLLs
 385 and lots of lib files and other stuff in %WXDIR%\lib\vc_dll.</p>
 386 </li>
 387 <li><p class="first">Building wxPython on Windows is very similar to doing it for the
 388 unix systems.  We're not going to install the development version
 389 of wxPython with these commands, so it won't impact your already
 390 installed version of the latest release.  You'll be able to test
 391 with this version when you want to, and use the installed release
 392 version the rest of the time.  If you ever do want to install the
 393 development version please refer to INSTALL.txt.</p>
 394 <p>Change to the %WXDIR%\wxPython dir and run the this command,
 395 making sure that you use the version of python that you want to
 396 build for (if you have more than one on your system) and to match
 397 the MONOLITHIC flag with how you built wxWidgets:</p>
 398 <pre class="literal-block">
 399 cd %WXDIR%\wxPython
 400 python setup.py build_ext --inplace MONOLITHIC=1
 401 </pre>
 402 <p>If you are wanting to have the source files regenerated with swig,
 403 then you need to turn on the USE_SWIG flag and optionally tell it
 404 where to find the new swig executable, so add these flags:</p>
 405 <pre class="literal-block">
 406 USE_SWIG=1 SWIG=e:\projects\SWIG-cvs\swig.exe
 407 </pre>
 408 <p>If you built a Unicode version of wxWidgets and want to also build
 409 the Unicode version of wxPython then add this flag:</p>
 410 <pre class="literal-block">
 411 UNICODE=1
 412 </pre>
 413 <p>If you have a debug version of Python and wxWidgets and want to
 414 build a debug version of wxPython too, add the --debug flag to the
 415 command line.  You should then end up with a set of <tt class="docutils literal"><span class="pre">*_d.pyd</span></tt>
 416 files in the wx package and you'll have to run <tt class="docutils literal"><span class="pre">python_d.exe</span></tt> to
 417 use them.  The debug and hybrid(release) versions can coexist.</p>
 418 <p>When the setup.py command is done you should have fully populated
 419 wxPython and wx packages locally in %WXDIR%/wxPython/wxPython and
 420 %WXDIR%/wxPython/wx, with all the extension modules (<tt class="docutils literal"><span class="pre">*.pyd</span></tt>
 421 files) located in the wx package.</p>
 422 </li>
 423 <li><p class="first">To run code with the development version of wxPython, just set the
 424 PYTHONPATH to the wxPython dir in the CVS tree.  For example:</p>
 425 <pre class="literal-block">
 426 set PYTHONPATH=%WXDIR%\wxPython
 427 cd %WXDIR\wxPython\demo
 428 python demo.py
 429 </pre>
 430 </li>
 431 </ol>
 432 </div>
 433 </div>
 434 </body>
 435 </html>