Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 1 | ========================= |
| 2 | Python on Mac OS X README |
| 3 | ========================= |
| 4 | |
| 5 | :Authors: |
| 6 | Jack Jansen (2004-07), |
| 7 | Ronald Oussoren (2010-04), |
| 8 | Ned Deily (2012-06) |
| 9 | |
| 10 | :Version: 3.3.0 |
Jack Jansen | 0fdaee7 | 2002-08-02 21:45:27 +0000 | [diff] [blame] | 11 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 12 | This document provides a quick overview of some Mac OS X specific features in |
| 13 | the Python distribution. |
| 14 | |
Ronald Oussoren | 86b33c8 | 2010-04-30 11:41:56 +0000 | [diff] [blame] | 15 | * ``--enable-framework[=DIR]`` |
Ronald Oussoren | 6f6c562 | 2009-12-24 14:03:19 +0000 | [diff] [blame] | 16 | |
| 17 | If this argument is specified the build will create a Python.framework rather |
| 18 | than a traditional Unix install. See the section |
| 19 | _`Building and using a framework-based Python on Mac OS X` for more |
| 20 | information on frameworks. |
| 21 | |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 22 | If the optional directory argument is specified the framework is installed |
Ronald Oussoren | 86b33c8 | 2010-04-30 11:41:56 +0000 | [diff] [blame] | 23 | into that directory. This can be used to install a python framework into |
| 24 | your home directory:: |
| 25 | |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 26 | $ ./configure --enable-framework=/Users/ronald/Library/Frameworks |
Ronald Oussoren | 86b33c8 | 2010-04-30 11:41:56 +0000 | [diff] [blame] | 27 | $ make && make install |
| 28 | |
| 29 | This will install the framework itself in ``/Users/ronald/Library/Frameworks``, |
| 30 | the applications in a subdirectory of ``/Users/ronald/Applications`` and the |
| 31 | command-line tools in ``/Users/ronald/bin``. |
| 32 | |
Ronald Oussoren | 6f6c562 | 2009-12-24 14:03:19 +0000 | [diff] [blame] | 33 | * ``--with-framework-name=NAME`` |
| 34 | |
| 35 | Specify the name for the python framework, defaults to ``Python``. This option |
| 36 | is only valid when ``--enable-framework`` is specified. |
| 37 | |
| 38 | * ``--enable-universalsdk[=PATH]`` |
| 39 | |
Terry Jan Reedy | 65e69b3 | 2013-03-11 17:23:46 -0400 | [diff] [blame] | 40 | Create a universal binary build of Python. This can be used with both |
Ronald Oussoren | 6f6c562 | 2009-12-24 14:03:19 +0000 | [diff] [blame] | 41 | regular and framework builds. |
| 42 | |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 43 | The optional argument specifies which OS X SDK should be used to perform the |
| 44 | build. If xcodebuild is available and configured, this defaults to |
| 45 | the Xcode default MacOS X SDK, otherwise ``/Developer/SDKs/MacOSX.10.4u.sdk`` |
| 46 | if available or ``/`` if not. |
Ronald Oussoren | 6f6c562 | 2009-12-24 14:03:19 +0000 | [diff] [blame] | 47 | |
| 48 | See the section _`Building and using a universal binary of Python on Mac OS X` |
| 49 | for more information. |
| 50 | |
| 51 | * ``--with-univeral-archs=VALUE`` |
| 52 | |
| 53 | Specify the kind of universal binary that should be created. This option is |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 54 | only valid when ``--enable-universalsdk`` is specified. The default is |
| 55 | ``32-bit`` if a building with a SDK that supports PPC, otherwise defaults |
| 56 | to ``intel``. |
Ronald Oussoren | 6f6c562 | 2009-12-24 14:03:19 +0000 | [diff] [blame] | 57 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 58 | |
| 59 | Building and using a universal binary of Python on Mac OS X |
| 60 | =========================================================== |
| 61 | |
| 62 | 1. What is a universal binary |
| 63 | ----------------------------- |
| 64 | |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 65 | A universal binary build of Python contains object code for more than one |
| 66 | CPU architecture. A universal OS X executable file or library combines the |
| 67 | architecture-specific code into one file and can therefore run at native |
| 68 | speed on all supported architectures. Universal files were introduced in |
| 69 | OS X 10.4 to add support for Intel-based Macs to the existing PowerPC (PPC) |
| 70 | machines. In OS X 10.5 support was extended to 64-bit Intel and 64-bit PPC |
| 71 | architectures. It is possible to build Python with various combinations |
| 72 | of architectures depending on the build tools and OS X version in use. |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 73 | |
| 74 | 2. How do I build a universal binary |
| 75 | ------------------------------------ |
| 76 | |
| 77 | You can enable universal binaries by specifying the "--enable-universalsdk" |
| 78 | flag to configure:: |
| 79 | |
| 80 | $ ./configure --enable-universalsdk |
| 81 | $ make |
| 82 | $ make install |
| 83 | |
Ned Deily | e742ade | 2012-03-17 10:29:41 -0700 | [diff] [blame] | 84 | This flag can be used with a framework build of python, but also with a classic |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 85 | unix build. Universal builds were first supported with OS X 10.4 with Xcode 2.1 |
| 86 | and the 10.4u SDK. Starting with Xcode 3 and OS X 10.5, more configurations are |
| 87 | available. |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 88 | |
Ned Deily | 892f4f9 | 2014-02-11 17:57:37 -0800 | [diff] [blame^] | 89 | In general, universal builds depend on specific features provided by the |
| 90 | Apple-supplied compilers and other build tools included in Apple's Xcode |
| 91 | development tools. You should install Xcode and the command line tools |
| 92 | component appropriate for the OS X release you are running on. See the |
| 93 | Python Developer's Guide (http://docs.python.org/devguide/setup.html) |
| 94 | for more information. |
| 95 | |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 96 | 2.1 Flavors of universal binaries |
| 97 | ................................. |
Ronald Oussoren | 6f6c562 | 2009-12-24 14:03:19 +0000 | [diff] [blame] | 98 | |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 99 | It is possible to build a number of flavors of the universal binary build, |
| 100 | the default is a 32-bit only binary (i386 and ppc) in build environments that |
| 101 | support ppc (10.4 with Xcode 2, 10.5 and 10.6 with Xcode 3) or an |
| 102 | Intel-32/-64-bit binary (i386 and X86_64) in build environments that do not |
| 103 | support ppc (Xcode 4 on 10.6 and later systems). The flavor can be specified |
| 104 | using the configure option ``--with-universal-archs=VALUE``. The following |
Ronald Oussoren | 6f6c562 | 2009-12-24 14:03:19 +0000 | [diff] [blame] | 105 | values are available: |
| 106 | |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 107 | * ``intel``: ``i386``, ``x86_64`` |
| 108 | |
Ronald Oussoren | 6f6c562 | 2009-12-24 14:03:19 +0000 | [diff] [blame] | 109 | * ``32-bit``: ``ppc``, ``i386`` |
| 110 | |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 111 | * ``3-way``: ``i386``, ``x86_64``, ``ppc`` |
| 112 | |
Ronald Oussoren | 6f6c562 | 2009-12-24 14:03:19 +0000 | [diff] [blame] | 113 | * ``64-bit``: ``ppc64``, ``x86_64`` |
| 114 | |
| 115 | * ``all``: ``ppc``, ``ppc64``, ``i386``, ``x86_64`` |
| 116 | |
Ronald Oussoren | 6f6c562 | 2009-12-24 14:03:19 +0000 | [diff] [blame] | 117 | To build a universal binary that includes a 64-bit architecture, you must build |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 118 | on a system running OS X 10.5 or later. The ``all`` and ``64-bit`` flavors can |
| 119 | only be built with an 10.5 SDK because ``ppc64`` support was only included with |
| 120 | OS X 10.5. Although legacy ``ppc`` support was included with Xcode 3 on OS X |
| 121 | 10.6, it was removed in Xcode 4, versions of which were released on OS X 10.6 |
| 122 | and which is the current standard for OS X 10.7 and 10.8. To summarize, the |
| 123 | following combinations of SDKs and universal-archs flavors are available: |
Ronald Oussoren | 6f6c562 | 2009-12-24 14:03:19 +0000 | [diff] [blame] | 124 | |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 125 | * 10.4u SDK with Xcode 2 supports ``32-bit`` only |
| 126 | |
| 127 | * 10.5 SDK with Xcode 3.1.x supports all flavors |
| 128 | |
| 129 | * 10.6 SDK with Xcode 3.2.x supports ``intel``, ``3-way``, and ``32-bit`` |
| 130 | |
| 131 | * 10.6 SDK with Xcode 4 supports ``intel`` only |
| 132 | |
| 133 | * 10.7 and 10.8 SDKs with Xcode 4 support ``intel`` only |
| 134 | |
| 135 | The makefile for a framework build will also install ``python3.3-32`` |
| 136 | binaries when the universal architecture includes at least one 32-bit |
| 137 | architecture (that is, for all flavors but ``64-bit``). |
Ronald Oussoren | 6f6c562 | 2009-12-24 14:03:19 +0000 | [diff] [blame] | 138 | |
Ned Deily | 5c0b1ca | 2012-08-24 19:57:33 -0700 | [diff] [blame] | 139 | Running a specific architecture |
| 140 | ............................... |
Ronald Oussoren | 6f6c562 | 2009-12-24 14:03:19 +0000 | [diff] [blame] | 141 | |
| 142 | You can run code using a specific architecture using the ``arch`` command:: |
| 143 | |
| 144 | $ arch -i386 python |
| 145 | |
| 146 | Or to explicitly run in 32-bit mode, regardless of the machine hardware:: |
| 147 | |
| 148 | $ arch -i386 -ppc python |
| 149 | |
| 150 | NOTE: When you're using a framework install of Python this requires at least |
| 151 | Python 2.7 or 3.2, in earlier versions the python (and pythonw) commands are |
| 152 | wrapper tools that execute the real interpreter without ensuring that the |
| 153 | real interpreter runs with the same architecture. |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 154 | |
Ned Deily | 5c0b1ca | 2012-08-24 19:57:33 -0700 | [diff] [blame] | 155 | Using ``arch`` is not a perfect solution as the selected architecture will |
| 156 | not automatically carry through to subprocesses launched by programs and tests |
| 157 | under that Python. If you want to ensure that Python interpreters launched in |
| 158 | subprocesses also run in 32-bit-mode if the main interpreter does, use |
| 159 | a ``python3.3-32`` binary and use the value of ``sys.executable`` as the |
| 160 | ``subprocess`` ``Popen`` executable value. |
| 161 | |
| 162 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 163 | Building and using a framework-based Python on Mac OS X. |
| 164 | ======================================================== |
| 165 | |
Jack Jansen | 0fdaee7 | 2002-08-02 21:45:27 +0000 | [diff] [blame] | 166 | |
Brett Cannon | 98809b7 | 2004-12-06 06:01:13 +0000 | [diff] [blame] | 167 | 1. Why would I want a framework Python instead of a normal static Python? |
Jack Jansen | 0fdaee7 | 2002-08-02 21:45:27 +0000 | [diff] [blame] | 168 | -------------------------------------------------------------------------- |
| 169 | |
Jack Jansen | 1f74ed8 | 2002-09-06 21:00:55 +0000 | [diff] [blame] | 170 | The main reason is because you want to create GUI programs in Python. With the |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 171 | exception of X11/XDarwin-based GUI toolkits all GUI programs need to be run |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 172 | from a Mac OSX application bundle (".app"). |
Jack Jansen | 0fdaee7 | 2002-08-02 21:45:27 +0000 | [diff] [blame] | 173 | |
Jack Jansen | 1f74ed8 | 2002-09-06 21:00:55 +0000 | [diff] [blame] | 174 | While it is technically possible to create a .app without using frameworks you |
| 175 | will have to do the work yourself if you really want this. |
Jack Jansen | 0fdaee7 | 2002-08-02 21:45:27 +0000 | [diff] [blame] | 176 | |
Jack Jansen | 1f74ed8 | 2002-09-06 21:00:55 +0000 | [diff] [blame] | 177 | A second reason for using frameworks is that they put Python-related items in |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 178 | only two places: "/Library/Framework/Python.framework" and |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 179 | "/Applications/Python <VERSION>" where ``<VERSION>`` can be e.g. "3.3", |
| 180 | "2.7", etc. This simplifies matters for users installing |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 181 | Python from a binary distribution if they want to get rid of it again. Moreover, |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 182 | due to the way frameworks work, a user without admin privileges can install a |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 183 | binary distribution in his or her home directory without recompilation. |
Jack Jansen | 7c0d7ba | 2003-06-20 15:14:08 +0000 | [diff] [blame] | 184 | |
Jack Jansen | 0fdaee7 | 2002-08-02 21:45:27 +0000 | [diff] [blame] | 185 | 2. How does a framework Python differ from a normal static Python? |
| 186 | ------------------------------------------------------------------ |
| 187 | |
| 188 | In everyday use there is no difference, except that things are stored in |
| 189 | a different place. If you look in /Library/Frameworks/Python.framework |
| 190 | you will see lots of relative symlinks, see the Apple documentation for |
| 191 | details. If you are used to a normal unix Python file layout go down to |
| 192 | Versions/Current and you will see the familiar bin and lib directories. |
| 193 | |
| 194 | 3. Do I need extra packages? |
| 195 | ---------------------------- |
| 196 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 197 | Yes, probably. If you want Tkinter support you need to get the OSX AquaTk |
Ned Deily | 5c0b1ca | 2012-08-24 19:57:33 -0700 | [diff] [blame] | 198 | distribution, this is installed by default on Mac OS X 10.4 or later. Be |
| 199 | aware, though, that the Cocoa-based AquaTk's supplied starting with OS X |
| 200 | 10.6 have proven to be unstable. If possible, you should consider |
| 201 | installing a newer version before building on OS X 10.6 or later, such as |
| 202 | the ActiveTcl 8.5. See http://www.python.org/download/mac/tcltk/. If you |
| 203 | are building with an SDK, ensure that the newer Tcl and Tk frameworks are |
| 204 | seen in the SDK's ``Library/Frameworks`` directory; you may need to |
| 205 | manually create symlinks to their installed location, ``/Library/Frameworks``. |
| 206 | If you want wxPython you need to get that. |
| 207 | If you want Cocoa you need to get PyObjC. |
Jack Jansen | 0fdaee7 | 2002-08-02 21:45:27 +0000 | [diff] [blame] | 208 | |
| 209 | 4. How do I build a framework Python? |
| 210 | ------------------------------------- |
| 211 | |
Jack Jansen | 21ed16a | 2002-08-02 14:11:24 +0000 | [diff] [blame] | 212 | This directory contains a Makefile that will create a couple of python-related |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 213 | applications (full-blown OSX .app applications, that is) in |
| 214 | "/Applications/Python <VERSION>", and a hidden helper application Python.app |
| 215 | inside the Python.framework, and unix tools "python" and "pythonw" into |
| 216 | /usr/local/bin. In addition it has a target "installmacsubtree" that installs |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 217 | the relevant portions of the Mac subtree into the Python.framework. |
Jack Jansen | 0511b76 | 2001-09-06 16:36:42 +0000 | [diff] [blame] | 218 | |
Jack Jansen | 21ed16a | 2002-08-02 14:11:24 +0000 | [diff] [blame] | 219 | It is normally invoked indirectly through the main Makefile, as the last step |
| 220 | in the sequence |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 221 | |
| 222 | 1. ./configure --enable-framework |
| 223 | |
| 224 | 2. make |
| 225 | |
| 226 | 3. make install |
Jack Jansen | 0fdaee7 | 2002-08-02 21:45:27 +0000 | [diff] [blame] | 227 | |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 228 | This sequence will put the framework in ``/Library/Framework/Python.framework``, |
| 229 | the applications in ``/Applications/Python <VERSION>`` and the unix tools in |
| 230 | ``/usr/local/bin``. |
Jack Jansen | 7a1703d | 2002-08-12 20:46:18 +0000 | [diff] [blame] | 231 | |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 232 | Installing in another place, for instance ``$HOME/Library/Frameworks`` if you |
| 233 | have no admin privileges on your machine, is possible. This can be accomplished |
| 234 | by configuring with ``--enable-framework=$HOME/Library/Frameworks``. |
| 235 | The other two directories will then also be installed in your home directory, |
| 236 | at ``$HOME/Applications/Python-<VERSION>`` and ``$HOME/bin``. |
Jack Jansen | 7a1703d | 2002-08-12 20:46:18 +0000 | [diff] [blame] | 237 | |
| 238 | If you want to install some part, but not all, read the main Makefile. The |
Jack Jansen | 1f74ed8 | 2002-09-06 21:00:55 +0000 | [diff] [blame] | 239 | frameworkinstall is composed of a couple of sub-targets that install the |
| 240 | framework itself, the Mac subtree, the applications and the unix tools. |
Jack Jansen | 7a1703d | 2002-08-12 20:46:18 +0000 | [diff] [blame] | 241 | |
Jack Jansen | 7c0d7ba | 2003-06-20 15:14:08 +0000 | [diff] [blame] | 242 | There is an extra target frameworkinstallextras that is not part of the |
Georg Brandl | 59b4472 | 2010-12-30 22:12:40 +0000 | [diff] [blame] | 243 | normal frameworkinstall which installs the Tools directory into |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 244 | "/Applications/Python <VERSION>", this is useful for binary |
Brett Cannon | 85266da | 2009-12-13 21:15:41 +0000 | [diff] [blame] | 245 | distributions. |
Jack Jansen | 7c0d7ba | 2003-06-20 15:14:08 +0000 | [diff] [blame] | 246 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 247 | What do all these programs do? |
| 248 | =============================== |
Jack Jansen | 7a1703d | 2002-08-12 20:46:18 +0000 | [diff] [blame] | 249 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 250 | "IDLE.app" is an integrated development environment for Python: editor, |
Jack Jansen | 0fdaee7 | 2002-08-02 21:45:27 +0000 | [diff] [blame] | 251 | debugger, etc. |
| 252 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 253 | "PythonLauncher.app" is a helper application that will handle things when you |
Jack Jansen | 0fdaee7 | 2002-08-02 21:45:27 +0000 | [diff] [blame] | 254 | double-click a .py, .pyc or .pyw file. For the first two it creates a Terminal |
Jack Jansen | 1f74ed8 | 2002-09-06 21:00:55 +0000 | [diff] [blame] | 255 | window and runs the scripts with the normal command-line Python. For the |
| 256 | latter it runs the script in the Python.app interpreter so the script can do |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 257 | GUI-things. Keep the ``Option`` key depressed while dragging or double-clicking |
| 258 | a script to set runtime options. These options can be set persistently |
Jack Jansen | 1f74ed8 | 2002-09-06 21:00:55 +0000 | [diff] [blame] | 259 | through PythonLauncher's preferences dialog. |
Jack Jansen | 0fdaee7 | 2002-08-02 21:45:27 +0000 | [diff] [blame] | 260 | |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 261 | The program ``pythonx.x`` runs python scripts from the command line. Various |
| 262 | compatibility aliases are also installed, including ``pythonwx.x`` which |
| 263 | in early releases of Python on OS X was required to run GUI programs. In |
| 264 | current releases, the ``pythonx.x`` and ``pythonwx.x`` commands are identical. |
Jack Jansen | 0fdaee7 | 2002-08-02 21:45:27 +0000 | [diff] [blame] | 265 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 266 | How do I create a binary distribution? |
| 267 | ====================================== |
Jack Jansen | 8ba4220 | 2002-09-06 20:24:51 +0000 | [diff] [blame] | 268 | |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 269 | Download and unpack the source release from http://www.python.org/download/. |
| 270 | Go to the directory ``Mac/BuildScript``. There you will find a script |
| 271 | ``build-installer.py`` that does all the work. This will download and build |
Ned Deily | e742ade | 2012-03-17 10:29:41 -0700 | [diff] [blame] | 272 | a number of 3rd-party libaries, configures and builds a framework Python, |
| 273 | installs it, creates the installer package files and then packs this in a |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 274 | DMG image. The script also builds an HTML copy of the current Python |
| 275 | documentation set for this release for inclusion in the framework. The |
| 276 | installer package will create links to the documentation for use by IDLE, |
| 277 | pydoc, shell users, and Finder user. |
Jack Jansen | 4f90137 | 2004-07-15 21:30:41 +0000 | [diff] [blame] | 278 | |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 279 | The script will build a universal binary so you'll therefore have to run this |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 280 | script on Mac OS X 10.4 or later and with Xcode 2.1 or later installed. |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 281 | However, the Python build process itself has several build dependencies not |
| 282 | available out of the box with OS X 10.4 so you may have to install |
| 283 | additional software beyond what is provided with Xcode 2. OS X 10.5 |
| 284 | provides a recent enough system Python (in ``/usr/bin``) to build |
Ned Deily | 5c0b1ca | 2012-08-24 19:57:33 -0700 | [diff] [blame] | 285 | the Python documentation set. It should be possible to use SDKs and/or older |
| 286 | versions of Xcode to build installers that are compatible with older systems |
| 287 | on a newer system but this may not be completely foolproof so the resulting |
| 288 | executables, shared libraries, and ``.so`` bundles should be carefully |
| 289 | examined and tested on all supported systems for proper dynamic linking |
| 290 | dependencies. It is safest to build the distribution on a system running the |
| 291 | minimum OS X version supported. |
Jack Jansen | 8ba4220 | 2002-09-06 20:24:51 +0000 | [diff] [blame] | 292 | |
Jack Jansen | 7c0d7ba | 2003-06-20 15:14:08 +0000 | [diff] [blame] | 293 | All of this is normally done completely isolated in /tmp/_py, so it does not |
| 294 | use your normal build directory nor does it install into /. |
Jack Jansen | 8ba4220 | 2002-09-06 20:24:51 +0000 | [diff] [blame] | 295 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 296 | Because of the way the script locates the files it needs you have to run it |
| 297 | from within the BuildScript directory. The script accepts a number of |
| 298 | command-line arguments, run it with --help for more information. |
Jack Jansen | 8ba4220 | 2002-09-06 20:24:51 +0000 | [diff] [blame] | 299 | |
Ronald Oussoren | f9adc37 | 2010-02-07 11:46:38 +0000 | [diff] [blame] | 300 | Configure warnings |
| 301 | ================== |
| 302 | |
| 303 | The configure script sometimes emits warnings like the one below:: |
| 304 | |
| 305 | configure: WARNING: libintl.h: present but cannot be compiled |
| 306 | configure: WARNING: libintl.h: check for missing prerequisite headers? |
| 307 | configure: WARNING: libintl.h: see the Autoconf documentation |
| 308 | configure: WARNING: libintl.h: section "Present But Cannot Be Compiled" |
| 309 | configure: WARNING: libintl.h: proceeding with the preprocessor's result |
| 310 | configure: WARNING: libintl.h: in the future, the compiler will take precedence |
| 311 | configure: WARNING: ## -------------------------------------- ## |
| 312 | configure: WARNING: ## Report this to http://bugs.python.org/ ## |
| 313 | configure: WARNING: ## -------------------------------------- ## |
| 314 | |
| 315 | This almost always means you are trying to build a universal binary for |
Ned Deily | 5c0b1ca | 2012-08-24 19:57:33 -0700 | [diff] [blame] | 316 | Python and have libraries in ``/usr/local`` that don't contain the required |
Ronald Oussoren | f9adc37 | 2010-02-07 11:46:38 +0000 | [diff] [blame] | 317 | architectures. Temporarily move ``/usr/local`` aside to finish the build. |
| 318 | |
Ronald Oussoren | 56d6410 | 2010-04-30 15:13:13 +0000 | [diff] [blame] | 319 | |
| 320 | Uninstalling a framework install, including the binary installer |
| 321 | ================================================================ |
| 322 | |
Ned Deily | e742ade | 2012-03-17 10:29:41 -0700 | [diff] [blame] | 323 | Uninstalling a framework can be done by manually removing all bits that got installed. |
| 324 | That's true for both installations from source and installations using the binary installer. |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 325 | OS X does not provide a central uninstaller. |
Ronald Oussoren | 56d6410 | 2010-04-30 15:13:13 +0000 | [diff] [blame] | 326 | |
| 327 | The main bit of a framework install is the framework itself, installed in |
| 328 | ``/Library/Frameworks/Python.framework``. This can contain multiple versions |
| 329 | of Python, if you want to remove just one version you have to remove the |
| 330 | version-specific subdirectory: ``/Library/Frameworks/Python.framework/Versions/X.Y``. |
| 331 | If you do that, ensure that ``/Library/Frameworks/Python.framework/Versions/Current`` |
| 332 | is a symlink that points to an installed version of Python. |
| 333 | |
| 334 | A framework install also installs some applications in ``/Applications/Python X.Y``, |
| 335 | |
| 336 | And lastly a framework installation installs files in ``/usr/local/bin``, all of |
| 337 | them symbolic links to files in ``/Library/Frameworks/Python.framework/Versions/X.Y/bin``. |
| 338 | |
Jack Jansen | 408c16f | 2001-09-11 11:30:02 +0000 | [diff] [blame] | 339 | |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 340 | Resources |
| 341 | ========= |
Jack Jansen | 0511b76 | 2001-09-06 16:36:42 +0000 | [diff] [blame] | 342 | |
Ned Deily | 8e5c0a7 | 2012-06-23 23:13:24 -0700 | [diff] [blame] | 343 | * http://www.python.org/download/mac/ |
| 344 | |
| 345 | * http://www.python.org/community/sigs/current/pythonmac-sig/ |
| 346 | |
| 347 | * http://docs.python.org/devguide/ |