| Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 1 | |
| 2 | INSTALLATION INSTRUCTIONS FOR pyOpenSSL |
| 3 | ------------------------------------------------------------------------------ |
| 4 | |
| 5 | I have tested this on Debian Linux systems (woody and sid), Solaris 2.6 and |
| 6 | 2.7. Others have successfully compiled it on Windows and NT. |
| 7 | |
| 8 | |
| 9 | -- Building the Module on a Unix System -- |
| 10 | |
| 11 | pyOpenSSL uses distutils, so there really shouldn't be any problems. To build |
| 12 | the library: |
| 13 | |
| 14 | python setup.py build |
| 15 | |
| 16 | If your OpenSSL header files aren't in /usr/include, you may need to supply |
| 17 | the -I flag to let the setup script know where to look. The same goes for the |
| 18 | libraries of course, use the -L flag. Note that build won't accept these |
| 19 | flags, so you have to run first build_ext and then build! Example: |
| 20 | |
| 21 | python setup.py build_ext -I/usr/local/ssl/include -L/usr/local/ssl/lib |
| 22 | python setup.py build |
| 23 | |
| 24 | Now you should have a directory called OpenSSL that contains e.g. SSL.so and |
| 25 | __init__.py somewhere in the build dicrectory, so just: |
| 26 | |
| 27 | python setup.py install |
| 28 | |
| 29 | If you, for some arcane reason, don't want the module to appear in the |
| 30 | site-packages directory, use the --prefix option. |
| 31 | |
| 32 | You can, of course, do |
| 33 | |
| 34 | python setup.py --help |
| 35 | |
| 36 | to find out more about how to use the script. |
| 37 | |
| 38 | |
| 39 | -- Building the Module on a Windows System -- |
| 40 | |
| 41 | Big thanks to Itamar Shtull-Trauring and Oleg Orlov for their help with |
| 42 | Windows build instructions. Same as for Unix systems, we have to separate |
| 43 | the build_ext and the build. |
| 44 | |
| 45 | Building the library: |
| 46 | |
| 47 | setup.py build_ext -I ...\openssl\inc32 -L ...\openssl\out32dll |
| 48 | setup.py build |
| 49 | |
| 50 | Where ...\openssl is of course the location of your OpenSSL installation. |
| 51 | |
| 52 | Installation is the same as for Unix systems: |
| 53 | |
| 54 | setup.py install |
| 55 | |
| 56 | And similarily, you can do |
| 57 | |
| 58 | setup.py --help |
| 59 | |
| 60 | to get more information. |
| 61 | |
| 62 | |
| 63 | -- Documentation -- |
| 64 | |
| 65 | The documentation is written in LaTeX, using the standard Python templates, |
| 66 | and tools to compile it into a number of forms are included. You need to |
| 67 | supply things like dvips, latex2html yourself of course! |
| 68 | |
| 69 | To build the text, html, postscript or dvi forms of the documentation, this is |
| 70 | what you do: |
| 71 | |
| 72 | cd doc |
| 73 | # To make the text-only documentation: |
| 74 | make text |
| 75 | # To make the dvi form: |
| 76 | make dvi |
| 77 | |
| 78 | It's as simple as that. Note that since Python's mkhowto script is used, if |
| 79 | you do first ``make dvi'' and then ``make ps'', the dvi file will disappear. |
| 80 | I included a special build target ``make all'' that will build all the |
| 81 | documentation in an order that won't let anything disappear. |
| 82 | |
| 83 | |
| 84 | @(#) $Id: INSTALL,v 1.7 2002/06/14 12:14:19 martin Exp $ |