blob: 5cee8fd72c41409de4cbd77dfec41f8251c1fc2b [file] [log] [blame]
Guido van Rossum082d2891997-05-16 16:24:09 +00001Welcome to the "PC" subdirectory of the Python distribution!
2************************************************************
3
4
5This "PC" subdirectory contains complete project files to make
6several PC ports of Python, as well as all the PC-specific
7Python source files. It should be located in the root of the
8Python distribution, and there should be directories "Modules",
9"Objects", "Python", etc. in the parent directory of this "PC"
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +000010subdirectory. Be sure to read the documentation in the Python
11distribution.
Guido van Rossum082d2891997-05-16 16:24:09 +000012
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +000013Python requires library files such as string.py to be available in
14one or more library directories. The search path of libraries is
15set up when Python starts. To see the current Python library search
16path, start Python and enter "import sys" and "print sys.path".
17
Guido van Rossum831c2581997-08-14 22:57:33 +000018All PC ports use this scheme to try to set up a module search path:
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +000019
Guido van Rossum831c2581997-08-14 22:57:33 +000020 1) The script location; the current directory without script.
21 2) The PYTHONPATH variable, if set.
22 3) For Win32 platforms (NT/95), paths specified in the Registry.
23 4) Default directories lib, lib/win, lib/test, lib/tkinter;
24 these are searched relative to the environment variable
25 PYTHONHOME, if set, or relative to the executable and its
26 ancestors, if a landmark file (Lib/string.py) is found ,
27 or the current directory (not useful).
28 5) The directory containing the executable.
29
30The best installation strategy is to put the Python executable (and
31DLL, for Win32 platforms) in some convenient directory such as
32C:/python, and copy all library files and subdirectories (using XCOPY)
33to C:/python/lib. Then you don't need to set PYTHONPATH. Otherwise,
34set the environment variable PYTHONPATH to your Python search path.
35For example,
Guido van Rossumffeb59381997-12-17 21:27:23 +000036 set PYTHONPATH=.;d:\python\lib;d:\python\lib\win;d:\python\lib\dos-8x3
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +000037
Guido van Rossum082d2891997-05-16 16:24:09 +000038There are several add-in modules to build Python programs which use
39the native Windows operating environment. The ports here just make
40"QuickWin" and DOS Python versions which support a character-mode
41(console) environment. Look in www.python.org for Tkinter, PythonWin,
42WPY and wxPython.
43
44To make a Python port, start the Integrated Development Environment
45(IDE) of your compiler, and read in the native "project file"
46(or makefile) provided. This will enable you to change any source
47files or build settings so you can make custom builds.
48
49config.h An important configuration file specific to PC's.
50
51config.c The list of C modules to include in the Python PC
52 version. Manually edit this file to add or
53 remove Python modules.
54
55testpy.py A Python test program. Run this to test your
Guido van Rossum831c2581997-08-14 22:57:33 +000056 Python port. It should produce copious output,
57 ending in a report on how many tests were OK, how many
58 failed, and how many were skipped. Don't worry about
59 skipped tests (these test unavailable optional features).
Guido van Rossum082d2891997-05-16 16:24:09 +000060
61src A subdirectory used only for VC++ version 1.5 Python
62 source files. See below. The other compilers do not
63 use it. They reference the actual distribution
64 directories instead.
65
66
Guido van Rossume34b7de1997-05-19 20:01:57 +000067Microsoft Visual C++ Version 4.x (32-bit Windows)
Guido van Rossum082d2891997-05-16 16:24:09 +000068=================================================
69
Guido van Rossume34b7de1997-05-19 20:01:57 +000070(For historic reasons this uses the filename "vc40"; it has been tested
Guido van Rossum831c2581997-08-14 22:57:33 +000071most recently with VC 4.2. See below for VC 5.x.)
Guido van Rossum082d2891997-05-16 16:24:09 +000072
Guido van Rossum85f8b091997-12-15 18:31:32 +000073NOTE: VC 4.2 support is eroding, as I no longer have a VC 4.2
Guido van Rossum79882061997-12-16 22:26:02 +000074installation. Some newer files need to be added to the project.
Guido van Rossum85f8b091997-12-15 18:31:32 +000075
Guido van Rossum082d2891997-05-16 16:24:09 +000076The distributed Makefile is vc40.mak. This file is distributed with
77CRLF line separators, otherwise Developer Studio won't like it. It
78will NOT work from this PC directory. To use it, first copy it to the
79Python distribution directory, e.g. with this command:
80 copy vc40.mak ..
81To convert the Makefile into a project file, start Developer Studio,
82choose Open Workspace, change the file name pattern to *.mak, find and
83select the file vc40.mak, and click OK. Developer Studio will create
84additional project files vc40.ncb and vc40.mdp when you use the
85project. The project contains six targets, which should be built in
86this order:
87
Guido van Rossume34b7de1997-05-19 20:01:57 +000088python15 The Python core as a DLL, named python15.dll.
Guido van Rossum082d2891997-05-16 16:24:09 +000089
90python The Python main program, named python.exe. This should
91 work as a console program under Windows 95 or NT, as well
92 as under Windows 3.1(1) when using win32s. It uses
Guido van Rossume34b7de1997-05-19 20:01:57 +000093 python15.dll.
Guido van Rossum082d2891997-05-16 16:24:09 +000094
95_tkinter The optional _tkinter extension, _tkinter.dll; see below.
96
Guido van Rossum1aa7e3a1997-05-19 14:16:21 +000097All end products of the compilation are placed in the subdirectory
Guido van Rossum082d2891997-05-16 16:24:09 +000098vc40 (which Developer Studio creates); object files are placed in
99vc40/tmp. There are no separate Release and Debug project variants.
100Note that the python and _tkinter projects require that the
Guido van Rossume34b7de1997-05-19 20:01:57 +0000101python15.lib file exists in the vc40 subdirectory before they can be
Guido van Rossum082d2891997-05-16 16:24:09 +0000102built.
103
104*** How to build the _tkinter extension ***
105
106This assumes that you have installed the Tcl/Tk binary distribution for
107Windows 95/NT with version numbers 7.5p1/4.1p1, in the default
108installation location (C:\tcl). (Ftp to ftp.sunlabs.com in /pub/tcl,
109file win41p1.exe.) You must also fetch and unpack the zip file
110vclibs41.zip which contains the files tcl75.lib and tk41.lib, and place
111those files in the PC subdirectory. In order to use _tkinter, the
112Tkinter.py module must be on PYTHONPATH. It is found in the
113Lib\tkinter subdirectory.
114
Guido van Rossum831c2581997-08-14 22:57:33 +0000115Microsoft Visual C++ Version 5.x (Developer Studio)
116===================================================
117
118For Visual C++ 5.x (Developer Studio) the instructions are somewhat
119different again. Three project files (*.dsp) and a workspace file
120(pcbuild.dsw) are provided in the subdirectory vc5x. (These are the
121same three subprojects as discussed for VC++ 4.x.)
122
Guido van Rossumfd910561997-09-03 16:11:19 +0000123To use these, copy the files from vc5x to the toplevel PCbuild
124directory. Then open the pcbuild.dsw workspace file with Developer
125Studio. Select the Debug configuration (use Set Active
126Configuration... in the Build menu) and build the python15 and python
127projects (in that order). If you have Tcl/Tk 8.0 installed you can
128also try building the _tkinter project. If you plan to use the parser
129module, also build that project.
Guido van Rossum831c2581997-08-14 22:57:33 +0000130
Guido van Rossum082d2891997-05-16 16:24:09 +0000131
132Additional files and subdirectories for 32-bit Windows
133======================================================
134
Guido van Rossume34b7de1997-05-19 20:01:57 +0000135python_nt.def Exports definition file for python15.dll.
Guido van Rossum082d2891997-05-16 16:24:09 +0000136
Guido van Rossume34b7de1997-05-19 20:01:57 +0000137python_nt.rc Resource compiler input for python15.dll.
Guido van Rossum082d2891997-05-16 16:24:09 +0000138
Guido van Rossum831c2581997-08-14 22:57:33 +0000139dl_nt.c, import_nt.c
Guido van Rossum082d2891997-05-16 16:24:09 +0000140 Additional sources used for 32-bit Windows features.
141
Guido van Rossum831c2581997-08-14 22:57:33 +0000142getpathp.c Default sys.path calculations (for all PC platforms).
Guido van Rossum082d2891997-05-16 16:24:09 +0000143
144dllbase_nt.txt A (manually maintained) list of base addresses for
145 various DLLs, to avoid run-time relocation.
146
147_tkinter.def The export definitions file for _tkinter.dll.
Guido van Rossum831c2581997-08-14 22:57:33 +0000148 (No longer needed; the /export:init_tkinter takes care
149 of this.)
Guido van Rossum082d2891997-05-16 16:24:09 +0000150
151make_nt.in Include file for nmake-based builds (unsupported).
152
153example_nt A subdirectory showing how to build an extension as a
154 DLL.
155
156setup_nt A subdirectory containing an experimental installer
157 using Python only.
158
159
160Microsoft Visual C++ Version 1.5 (16-bit Windows)
161=================================================
162
163Since VC++1.5 does not handle long file names, it is necessary
164to run the "makesrc.exe" program in this directory to copy
165Python files from the distribution to the directory "src"
166with shortened names. Included file names are shortened too.
167Do this before you attempt to build Python.
168
169The "makesrc.exe" program is a native NT program, and you must
170have NT, Windows 95 or Win32s to run it. Otherwise you will need
171to copy distribution files to src yourself.
172
173The makefiles are named *.mak and are located in directories
174starting with "vc15_". NOTE: When dependencies are scanned
175VC++ will create dependencies for directories which are not
176used because it fails to evaluate "#define" properly. You
177must manaully edit makefiles (*.mak) to remove references to
178"sys/" and other bad directories.
179
180vc15_lib A static Python library. Create this first because is
181 is required for vc15_w31.
182
183vc15_w31 A Windows 3.1x Python QuickWin (console-mode)
184 Python including sockets. Requires vc15_lib.
185
186
187Watcom C++ Version 10.6
188=======================
189
190The project file for the Watcom compiler is ./python.wpj.
191It will build Watcom versions in the directories wat_*.
192
193wat_dos A 32-bit extended DOS Python (console-mode) using the
194 dos4gw DOS extender. Sockets are not included.
195
196wat_os2 A 32-bit OS/2 Python (console-mode).
197 Sockets are not included.
Guido van Rossum0ba48ba1997-11-22 21:58:14 +0000198
Guido van Rossumcee1dca1997-12-05 22:06:23 +0000199
Guido van Rossum0ba48ba1997-11-22 21:58:14 +0000200IBM VisualAge C/C++ for OS/2
201============================
202
Guido van Rossumcee1dca1997-12-05 22:06:23 +0000203See os2vacpp/readme.txt. This platform is supported by Jeff Rush.