PCbuild/readme.txt

   1 Building Python using VC++ 6.0 or 5.0
   2 -------------------------------------
   3 This directory is used to build Python for Win32 platforms, e.g. Windows
   4 95, 98 and NT.  It requires Microsoft Visual C++ 6.x or 5.x.
   5 (For other Windows platforms and compilers, see ../PC/readme.txt.)
   6
   7 All you need to do is open the workspace "pcbuild.dsw" in MSVC++, select
   8 the Debug or Release setting (using Build -> Set Active Configuration...),
   9 and build the projects.
  10
  11 The proper order to build subprojects:
  12
  13 1) pythoncore (this builds the main Python DLL and library files,
  14                python21.{dll, lib} in Release mode)
  15               NOTE:  in previous releases, this subproject was
  16               named after the release number, e.g. python20.
  17
  18 2) python (this builds the main Python executable,
  19            python.exe in Release mode)
  20
  21 3) the other subprojects, as desired or needed (note:  you probably don't
  22    want to build most of the other subprojects, unless you're building an
  23    entire Python distribution from scratch, or specifically making changes
  24    to the subsystems they implement; see SUBPROJECTS below)
  25
  26 When using the Debug setting, the output files have a _d added to
  27 their name:  python21_d.dll, python_d.exe, parser_d.pyd, and so on.
  28
  29 SUBPROJECTS
  30 -----------
  31 These subprojects should build out of the box.  Subprojects other than the
  32 main ones (pythoncore, python, pythonw) generally build a DLL (renamed to
  33 .pyd) from a specific module so that users don't have to load the code
  34 supporting that module unless they import the module.
  35
  36 pythoncore
  37     .dll and .lib
  38 python
  39     .exe
  40 pythonw
  41     pythonw.exe, a variant of python.exe that doesn't pop up a DOS box
  42 _socket
  43     socketmodule.c
  44 _sre
  45     Unicode-aware regular expression engine
  46 _symtable
  47     the _symtable module, symtablemodule.c
  48 _testcapi
  49     tests of the Python C API, run via Lib/test/test_capi.py, and
  50     implemented by module Modules/_testcapimodule.c
  51 mmap
  52     mmapmodule.c
  53 parser
  54     the parser module
  55 select
  56     selectmodule.c
  57 unicodedata
  58     large tables of Unicode data
  59 winreg
  60     Windows registry API
  61 winsound
  62     play sounds (typically .wav files) under Windows
  63
  64 The following subprojects will generally NOT build out of the box.  They
  65 wrap code Python doesn't control, and you'll need to download the base
  66 packages first and unpack them into siblings of PCbuilds's parent
  67 directory; for example, if your PCbuild is  .......\dist\src\PCbuild\,
  68 unpack into new subdirectories of dist\.
  69
  70 _tkinter
  71     Python wrapper for the Tk windowing system.  Requires tcl832.exe from
  72         http://dev.scriptics.com/software/tcltk/downloadnow83.html
  73     Run the installer, forcing installation into dist\Tcl.
  74     Be sure to install everything, including the Tcl/Tk header files.
  75
  76 zlib
  77     Python wrapper for the zlib compression library.  Get the source code
  78     for version 1.1.4 from a convenient mirror at:
  79         http://www.gzip.org/zlib/
  80     Unpack into dist\zlib-1.1.4.
  81     A custom pre-link step in the zlib project settings should manage to
  82     build zlib-1.1.4\zlib.lib by magic before zlib.pyd (or zlib_d.pyd) is
  83     linked in PCbuild\.
  84     However, the zlib project is not smart enough to remove anything under
  85     zlib-1.1.4\ when you do a clean, so if you want to rebuild zlib.lib
  86     you need to clean up zlib-1.1.4\ by hand.
  87
  88 bsddb
  89     Python wrapper for the BSD database 1.85.  Requires db.1.85.win32.zip,
  90     from the "bsd db" link at
  91         http://www.nightmare.com/software.html
  92     Unpack into dist\bsddb.
  93     You then need to compile it:  cd to dist\bsddb\Port\win32, and run
  94         nmake -f makefile_nt.msc
  95     This builds bsddb\Port\win32\db.lib, which the MSVC project links in.
  96     Note that if you're running Win9X, you'll need to run vcvars32.bat
  97     before running nmake (this batch file is in your MSVC installation).
  98     TODO:  make this work like zlib (in particular, MSVC runs the prelink
  99     step in an enviroment that already has the correct envars set up).
 100
 101 pyexpat
 102     Python wrapper for accelerated XML parsing.  Requires the Windows
 103     expat_win32bin installer from
 104         http://sourceforge.net/projects/expat/
 105     Currently using version 1.95.2.
 106     Install into dist\expat.
 107     You should also copy expat\Libs\expat.dll into your PCbuild directory,
 108     else at least two tests will fail (test_pyexpat and test_sax), and
 109     others will erroneously get skipped (at least test_minidom).
 110
 111
 112 NOTE ON CONFIGURATIONS
 113 ----------------------
 114 Under Build -> Configuration ..., you'll find several Alpha configurations,
 115 such as "Win32 Alpha Release".  These do not refer to alpha versions (as in
 116 alpha, beta, final), but to the DEC/COMPAQ Alpha processor.  Ignore them if
 117 you're not building on an Alpha box.
 118
 119
 120 YOUR OWN EXTENSION DLLs
 121 -----------------------
 122 If you want to create your own extension module DLL, there's an example
 123 with easy-to-follow instructions in ../PC/example/; read the file
 124 readme.txt there first.