diff options
Diffstat (limited to 'python/BuildInstructionsLinuxOSX.md')
| -rw-r--r-- | python/BuildInstructionsLinuxOSX.md | 39 |
1 files changed, 28 insertions, 11 deletions
diff --git a/python/BuildInstructionsLinuxOSX.md b/python/BuildInstructionsLinuxOSX.md index a97305800ad..4f0975e45fd 100644 --- a/python/BuildInstructionsLinuxOSX.md +++ b/python/BuildInstructionsLinuxOSX.md @@ -1,20 +1,27 @@ # Building Ice for Python on Linux and OS X -This page describes how to build and install Ice for Python from source code on Linux and OS X. If you prefer, you can also download [binary distributions](https://zeroc.com/download.html) for the supported platforms. +This page describes how to build and install Ice for Python from source code on +Linux and OS X. If you prefer, you can also download [binary distributions][1] +for the supported platforms. ## Python Build Requirements ### Operating Systems and Compilers -Ice for Python is expected to build and run properly on OS X and any recent Linux distribution for x86 and x86_64, and was extensively tested using the operating systems and compiler versions listed for our [supported platforms](https://zeroc.com/platforms_3_6_0.html). +Ice for Python is expected to build and run properly on OS X and any recent Linux +distribution for x86 and x86_64, and was extensively tested using the operating +systems and compiler versions listed for our [supported platforms][2]. ### Python Versions -Ice for Python supports Python versions 2.6, 2.7, 3.3 or 3.4. Note however that your Python installation must have been built with a C++ compiler that is compatible with the one used to build Ice for C++. +Ice for Python supports Python versions 2.6, 2.7, 3.3 or 3.4. Note however that +your Python installation must have been built with a C++ compiler that is +compatible with the one used to build Ice for C++. ### Ice Development Kit -You will need the Ice development kit for C++, which you can install as a binary distribution or compile from source yourself. +You will need the Ice development kit for C++, which you can install as a binary +distribution or compile from source yourself. ## Building the Python Extension @@ -22,21 +29,27 @@ Change to the Ice for Python source subdirectory: $ cd python -If you have not built Ice for C++ in the ```cpp``` subdirectory, set ```ICE_HOME``` to the directory of your Ice for C++ installation. For example: +If you have not built Ice for C++ in the `cpp` subdirectory, set `ICE_HOME` to +the directory of your Ice for C++ installation. For example: $ export ICE_HOME=/opt/Ice -Edit ```config/Make.rules```, modify the installation prefix (if necessary), and review the comments describing the ```PYTHON_VERSION``` variable. +Edit `config/Make.rules`, modify the installation prefix (if necessary), and +review the comments describing the `PYTHON_VERSION` variable. -Execute ```python -V``` to verify that the correct Python interpreter is in your executable search path. +Execute `python -V` to verify that the correct Python interpreter is in your +executable search path. -Run ```make``` to build the extension. +Run `make` to build the extension. -Upon successful completion, run ```make install```. You may need additional user privileges to install in the directory specified by ```config/Make.rules```. +Upon successful completion, run `make install`. You may need additional user +privileges to install in the directory specified by `config/Make.rules`. ## Configuring your Environment for Python -Modify your ```PYTHONPATH``` environment variable to include the Ice extension for Python. For example, assuming you installed the extension in the directory ```/opt/Ice```, you would modify your environment as shown below: +Modify your `PYTHONPATH` environment variable to include the Ice extension +for Python. For example, assuming you installed the extension in the directory +`/opt/Ice`, you would modify your environment as shown below: $ export PYTHONPATH=/opt/Ice/python:$PYTHONPATH @@ -46,4 +59,8 @@ After a successful build, you can run the tests as follows: $ python allTests.py -If everything worked out, you should see lots of ```ok``` messages. In case of a failure, the tests abort with ```failed```. +If everything worked out, you should see lots of `ok` messages. In case of a +failure, the tests abort with `failed`. + +[1]: https://zeroc.com/download.html +[2]: https://zeroc.com/platforms_3_6_0.html |