annotate docs/installation_win_old.rst @ 8395:482e163caccd i18n

Merge closed stable-i18n Everything has already landed.
author Mads Kiilerich <mads@kiilerich.com>
date Mon, 04 May 2020 19:24:04 +0200
parents 01aca0a4f876
children 0a9ddb8cd8c1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4814
d95ea48af67b docs: rename docs/installation_win.rst to docs/installation_win_old.rst, preparing for new docs
Mads Kiilerich <madski@unity3d.com>
parents: 4522
diff changeset
1 .. _installation_win_old:
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
2
8209
01aca0a4f876 py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents: 8193
diff changeset
3 .. warning:: This section is outdated and needs updating for Python 3.
01aca0a4f876 py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents: 8193
diff changeset
4
5954
8075ec3d0233 docs: restructure Kallithea upgrade instructions
Søren Løvborg <sorenl@unity3d.com>
parents: 5575
diff changeset
5 ==========================================================
8075ec3d0233 docs: restructure Kallithea upgrade instructions
Søren Løvborg <sorenl@unity3d.com>
parents: 5575
diff changeset
6 Installation on Windows (XP/Vista/Server 2003/Server 2008)
8075ec3d0233 docs: restructure Kallithea upgrade instructions
Søren Løvborg <sorenl@unity3d.com>
parents: 5575
diff changeset
7 ==========================================================
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
8
5433
fbbe80e3322b docs: consistent spacing around headings
Mads Kiilerich <madski@unity3d.com>
parents: 5425
diff changeset
9
5413
22a3fa3c4254 docs: cleanup of casing, markup and spacing of headings
Mads Kiilerich <madski@unity3d.com>
parents: 5125
diff changeset
10 First-time install
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5519
diff changeset
11 ------------------
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
12
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
13 Target OS: Windows XP SP3 32-bit English (Clean installation)
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
14 + All Windows Updates until 24-may-2012
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
15
2838
ba09e335f266 updated windows installation with note of 32 bit system used in example
Marcin Kuzminski <marcin@python-works.com>
parents: 2358
diff changeset
16 .. note::
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
17
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
18 This installation is for 32-bit systems, for 64-bit Windows you might need
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
19 to download proper 64-bit versions of the different packages (Windows Installer, Win32py extensions)
3358
321ca2e69004 installation win document updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3267
diff changeset
20 plus some extra tweaks.
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
21 These extra steps haven been marked as "64-bit".
3358
321ca2e69004 installation win document updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3267
diff changeset
22 Tested on Windows Server 2008 R2 SP1, 9-feb-2013.
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
23 If you run into any 64-bit related problems, please check these pages:
5435
60e04a21bf0f docs: more consistent use of --
Mads Kiilerich <madski@unity3d.com>
parents: 5434
diff changeset
24
3358
321ca2e69004 installation win document updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3267
diff changeset
25 - http://blog.victorjabur.com/2011/06/05/compiling-python-2-7-modules-on-windows-32-and-64-using-msvc-2008-express/
321ca2e69004 installation win document updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3267
diff changeset
26 - http://bugs.python.org/issue7511
2838
ba09e335f266 updated windows installation with note of 32 bit system used in example
Marcin Kuzminski <marcin@python-works.com>
parents: 2358
diff changeset
27
5435
60e04a21bf0f docs: more consistent use of --
Mads Kiilerich <madski@unity3d.com>
parents: 5434
diff changeset
28 Step 1 -- Install Visual Studio 2008 Express
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5519
diff changeset
29 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
30
4522
a9a1560dad79 setup: clarify that we only support 2.6 and 2.7
Mads Kiilerich <madski@unity3d.com>
parents: 4192
diff changeset
31 Optional: You can also install MinGW, but VS2008 installation is easier.
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
32
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
33 Download "Visual C++ 2008 Express Edition with SP1" from:
4815
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents: 4814
diff changeset
34 http://download.microsoft.com/download/E/8/E/E8EEB394-7F42-4963-A2D8-29559B738298/VS2008ExpressWithSP1ENUX1504728.iso
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents: 4814
diff changeset
35 (if not found or relocated, google for "visual studio 2008 express" for updated link. This link was taken from http://stackoverflow.com/questions/15318560/visual-c-2008-express-download-link-dead)
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
36
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
37 You can also download full ISO file for offline installation, just
5435
60e04a21bf0f docs: more consistent use of --
Mads Kiilerich <madski@unity3d.com>
parents: 5434
diff changeset
38 choose "All -- Offline Install ISO image file" in the previous page and
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
39 choose "Visual C++ 2008 Express" when installing.
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
40
3244
23c816fd6afb fixes #741 add note that VS2008 is the ONLY supported Visual Studio version
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
41 .. note::
3267
7b74079beec9 coding style: fix trailing and leading spaces and tabs
Mads Kiilerich <madski@unity3d.com>
parents: 3244
diff changeset
42
3365
2dfefa385fde sync docs changes from stable
Marcin Kuzminski <marcin@python-works.com>
parents: 3358
diff changeset
43 Using other versions of Visual Studio will lead to random crashes.
2dfefa385fde sync docs changes from stable
Marcin Kuzminski <marcin@python-works.com>
parents: 3358
diff changeset
44 You must use Visual Studio 2008!"
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
45
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
46 .. note::
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
47
3365
2dfefa385fde sync docs changes from stable
Marcin Kuzminski <marcin@python-works.com>
parents: 3358
diff changeset
48 Silverlight Runtime and SQL Server 2008 Express Edition are not
2dfefa385fde sync docs changes from stable
Marcin Kuzminski <marcin@python-works.com>
parents: 3358
diff changeset
49 required, you can uncheck them
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
50
3358
321ca2e69004 installation win document updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3267
diff changeset
51 .. note::
3413
d79f3505549e whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3365
diff changeset
52
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
53 64-bit: You also need to install the Microsoft Windows SDK for .NET 3.5 SP1 (.NET 4.0 won't work).
3365
2dfefa385fde sync docs changes from stable
Marcin Kuzminski <marcin@python-works.com>
parents: 3358
diff changeset
54 Download from: http://www.microsoft.com/en-us/download/details.aspx?id=3138
3358
321ca2e69004 installation win document updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3267
diff changeset
55
321ca2e69004 installation win document updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3267
diff changeset
56 .. note::
3365
2dfefa385fde sync docs changes from stable
Marcin Kuzminski <marcin@python-works.com>
parents: 3358
diff changeset
57
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
58 64-bit: You also need to copy and rename a .bat file to make the Visual C++ compiler work.
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
59 I am not sure why this is not necessary for 32-bit.
3365
2dfefa385fde sync docs changes from stable
Marcin Kuzminski <marcin@python-works.com>
parents: 3358
diff changeset
60 Copy C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\vcvars64.bat to C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\amd64\vcvarsamd64.bat
3358
321ca2e69004 installation win document updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3267
diff changeset
61
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
62 Step 2 -- Install Python
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5519
diff changeset
63 ^^^^^^^^^^^^^^^^^^^^^^^^
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
64
8209
01aca0a4f876 py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents: 8193
diff changeset
65 Install Python 3.8.x from:
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
66 http://www.python.org/download/
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
67
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
68 Remember the specific major and minor version installed, because it will
8209
01aca0a4f876 py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents: 8193
diff changeset
69 be needed in the next step. In this case, it is "3.8".
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
70
3358
321ca2e69004 installation win document updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3267
diff changeset
71 .. note::
3365
2dfefa385fde sync docs changes from stable
Marcin Kuzminski <marcin@python-works.com>
parents: 3358
diff changeset
72
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
73 64-bit: Just download and install the 64-bit version of python.
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
74
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
75 Step 3 -- Install Win32py extensions
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5519
diff changeset
76 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
77
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
78 Download pywin32 from:
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
79 http://sourceforge.net/projects/pywin32/files/
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
80
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
81 - Click on "pywin32" folder
8209
01aca0a4f876 py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents: 8193
diff changeset
82 - Click on the first folder (in this case, Build 218, maybe newer when you try)
01aca0a4f876 py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents: 8193
diff changeset
83 - Choose the file ending with ".win32-py3.x.exe" -> x being the minor
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
84 version of Python you installed (in this case, 7)
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
85 When writing this guide, the file was:
8209
01aca0a4f876 py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents: 8193
diff changeset
86 http://sourceforge.net/projects/pywin32/files/pywin32/Build%20218/pywin32-218.win-amd64-py3.8.exe/download
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
87
3358
321ca2e69004 installation win document updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3267
diff changeset
88 .. note::
3365
2dfefa385fde sync docs changes from stable
Marcin Kuzminski <marcin@python-works.com>
parents: 3358
diff changeset
89
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
90 64-bit: Download and install the 64-bit version.
3413
d79f3505549e whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3365
diff changeset
91 At the time of writing you can find this at:
8209
01aca0a4f876 py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents: 8193
diff changeset
92 http://sourceforge.net/projects/pywin32/files/pywin32/Build%20218/pywin32-218.win-amd64-py3.8.exe/download
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
93
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
94 Step 4 -- Python BIN
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5519
diff changeset
95 ^^^^^^^^^^^^^^^^^^^^
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
96
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
97 Add Python BIN folder to the path
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
98
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
99 You have to add the Python folder to the path, you can do it manually
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
100 (editing "PATH" environment variable) or using Windows Support Tools
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
101 that came preinstalled in Vista/7 and can be installed in Windows XP.
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
102
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
103 - Using support tools on WINDOWS XP:
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
104 If you use Windows XP you can install them using Windows XP CD and
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
105 navigating to \SUPPORT\TOOLS. There, execute Setup.EXE (not MSI).
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
106 Afterwards, open a CMD and type::
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
107
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
108 SETX PATH "%PATH%;[your-python-path]" -M
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
109
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
110 Close CMD (the path variable will be updated then)
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
111
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
112 - Using support tools on WINDOWS Vista/7:
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
113
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
114 Open a CMD and type::
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
115
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
116 SETX PATH "%PATH%;[your-python-path]" /M
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
117
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
118 Please substitute [your-python-path] with your Python installation path.
8209
01aca0a4f876 py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents: 8193
diff changeset
119 Typically: C:\\Python38
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
120
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
121 Step 5 -- Kallithea folder structure
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5519
diff changeset
122 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
123
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4185
diff changeset
124 Create a Kallithea folder structure
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
125
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4185
diff changeset
126 This is only a example to install Kallithea, you can of course change
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
127 it. However, this guide will follow the proposed structure, so please
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
128 later adapt the paths if you change them. My recommendation is to use
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
129 folders with NO SPACES. But you can try if you are brave...
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
130
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
131 Create the following folder structure::
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
132
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4185
diff changeset
133 C:\Kallithea
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4185
diff changeset
134 C:\Kallithea\Bin
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4185
diff changeset
135 C:\Kallithea\Env
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4185
diff changeset
136 C:\Kallithea\Repos
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
137
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
138 Step 6 -- Install virtualenv
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5519
diff changeset
139 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
140
8193
89e9aef9b983 py3: use "python3 -m venv" instead of virtualenv package
Mads Kiilerich <mads@kiilerich.com>
parents: 7791
diff changeset
141 Create a virtual Python environment in C:\\Kallithea\\Env (or similar). To
89e9aef9b983 py3: use "python3 -m venv" instead of virtualenv package
Mads Kiilerich <mads@kiilerich.com>
parents: 7791
diff changeset
142 do so, open a CMD (Python Path should be included in Step3), and write::
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
143
8193
89e9aef9b983 py3: use "python3 -m venv" instead of virtualenv package
Mads Kiilerich <mads@kiilerich.com>
parents: 7791
diff changeset
144 python3 -m venv C:\Kallithea\Env
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
145
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
146 Step 7 -- Install Kallithea
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5519
diff changeset
147 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
148
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4185
diff changeset
149 Finally, install Kallithea
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
150
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
151 Close previously opened command prompt/s, and open a Visual Studio 2008
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
152 Command Prompt (**IMPORTANT!!**). To do so, go to Start Menu, and then open
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
153 "Microsoft Visual C++ 2008 Express Edition" -> "Visual Studio Tools" ->
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
154 "Visual Studio 2008 Command Prompt"
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
155
3358
321ca2e69004 installation win document updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3267
diff changeset
156 .. note::
3365
2dfefa385fde sync docs changes from stable
Marcin Kuzminski <marcin@python-works.com>
parents: 3358
diff changeset
157
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
158 64-bit: For 64-bit you need to modify the shortcut that is used to start the
3365
2dfefa385fde sync docs changes from stable
Marcin Kuzminski <marcin@python-works.com>
parents: 3358
diff changeset
159 Visual Studio 2008 Command Prompt. Use right-mouse click to open properties.
2dfefa385fde sync docs changes from stable
Marcin Kuzminski <marcin@python-works.com>
parents: 3358
diff changeset
160
3358
321ca2e69004 installation win document updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3267
diff changeset
161 Change commandline from::
321ca2e69004 installation win document updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3267
diff changeset
162
321ca2e69004 installation win document updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3267
diff changeset
163 %comspec% /k ""C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcvarsall.bat"" x86
321ca2e69004 installation win document updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3267
diff changeset
164
321ca2e69004 installation win document updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3267
diff changeset
165 to::
321ca2e69004 installation win document updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3267
diff changeset
166
321ca2e69004 installation win document updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3267
diff changeset
167 %comspec% /k ""C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcvarsall.bat"" amd64
321ca2e69004 installation win document updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3267
diff changeset
168
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
169 In that CMD (loaded with VS2008 PATHs) type::
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
170
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4185
diff changeset
171 cd C:\Kallithea\Env\Scripts (or similar)
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
172 activate
5519
8c234ae2c258 docs: add advice of upgrading pip and setuptools in new virtualenvs
Mads Kiilerich <madski@unity3d.com>
parents: 5502
diff changeset
173 pip install --upgrade pip setuptools
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
174
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4185
diff changeset
175 The prompt will change into "(Env) C:\\Kallithea\\Env\\Scripts" or similar
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
176 (depending of your folder structure). Then type::
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
177
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4185
diff changeset
178 pip install kallithea
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
179
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
180 (long step, please wait until fully complete)
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
181
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
182 Some warnings will appear, don't worry as they are normal.
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
183
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
184 Step 8 -- Configuring Kallithea
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5519
diff changeset
185 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
186
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4185
diff changeset
187 steps taken from http://packages.python.org/Kallithea/setup.html
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
188
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
189 You have to use the same Visual Studio 2008 command prompt as Step7, so
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
190 if you closed it reopen it following the same commands (including the
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
191 "activate" one). When ready, just type::
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
192
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4185
diff changeset
193 cd C:\Kallithea\Bin
7406
7784a1212471 cli: convert 'gearbox make-config' into 'kallithea-cli config-create'
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7389
diff changeset
194 kallithea-cli config-create my.ini
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
195
7389
0955a02f7170 docs: align use of 'my.ini' as configfile placeholder
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 6555
diff changeset
196 Then, you must edit my.ini to fit your needs (network address and
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
197 port, mail settings, database, whatever). I recommend using NotePad++
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
198 (free) or similar text editor, as it handles well the EndOfLine
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
199 character differences between Unix and Windows
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
200 (http://notepad-plus-plus.org/)
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
201
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
202 For the sake of simplicity lets run it with the default settings. After
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
203 your edits (if any), in the previous Command Prompt, type::
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
204
7414
3158cf0dafb7 cli: convert 'gearbox setup-db' into 'kallithea-cli db-create'
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 7406
diff changeset
205 kallithea-cli db-create -c my.ini
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
206
5954
8075ec3d0233 docs: restructure Kallithea upgrade instructions
Søren Løvborg <sorenl@unity3d.com>
parents: 5575
diff changeset
207 .. warning:: This time a *new* database will be installed. You must
8075ec3d0233 docs: restructure Kallithea upgrade instructions
Søren Løvborg <sorenl@unity3d.com>
parents: 5575
diff changeset
208 follow a different process to later :ref:`upgrade <upgrade>`
8075ec3d0233 docs: restructure Kallithea upgrade instructions
Søren Løvborg <sorenl@unity3d.com>
parents: 5575
diff changeset
209 to a newer Kallithea version.
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
210
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
211 The script will ask you for confirmation about creating a NEW database,
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
212 answer yes (y)
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4185
diff changeset
213 The script will ask you for repository path, answer C:\\Kallithea\\Repos
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
214 (or similar)
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
215 The script will ask you for admin username and password, answer "admin"
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
216 + "123456" (or whatever you want)
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
217 The script will ask you for admin mail, answer "admin@xxxx.com" (or
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
218 whatever you want)
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
219
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
220 If you make some mistake and the script does not end, don't worry, start
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
221 it again.
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
222
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
223 Step 9 -- Running Kallithea
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5519
diff changeset
224 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
225
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4185
diff changeset
226 In the previous command prompt, being in the C:\\Kallithea\\Bin folder,
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
227 just type::
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
228
7389
0955a02f7170 docs: align use of 'my.ini' as configfile placeholder
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 6555
diff changeset
229 gearbox serve -c my.ini
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
230
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
231 Open yout web server, and go to http://127.0.0.1:5000
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
232
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
233 It works!! :-)
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
234
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
235 Remark:
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
236 If it does not work first time, just Ctrl-C the CMD process and start it
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
237 again. Don't forget the "http://" in Internet Explorer
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
238
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
239 What this Guide does not cover:
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
240
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
241 - Installing Celery
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4185
diff changeset
242 - Running Kallithea as Windows Service. You can investigate here:
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
243
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
244 - http://pypi.python.org/pypi/wsgisvc
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
245 - http://ryrobes.com/python/running-python-scripts-as-a-windows-service/
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
246 - http://wiki.pylonshq.com/display/pylonscookbook/How+to+run+Pylons+as+a+Windows+service
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
247
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
248 - Using Apache. You can investigate here:
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
249
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2838
diff changeset
250 - https://groups.google.com/group/rhodecode/msg/c433074e813ffdc4