[wxWidgets.git] / wxPython / docs / INSTALL.html

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