File: installation-binary.html

package info (click to toggle)
python-kinterbasdb 3.1-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 1,044 kB
  • ctags: 1,157
  • sloc: ansic: 6,879; python: 2,517; makefile: 77
file content (220 lines) | stat: -rw-r--r-- 7,886 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
<html>
<head>

<title>KInterbasDB Installation Guide - Binary Distribution</title>

<link rel="stylesheet" href="global.css" type="text/css">

</head>

<body>

<a href="index.html">Table of Contents</a>

<hr>

<h1 class="compactHeading">KInterbasDB Installation Guide - Binary Distribution</h1>

<p style="font-style: italic; font-size: 85%;">
<span style="font-weight: bold;">Note:</span>
If a binary distribution of KInterbasDB (e.g., a Windows executable installer)
is not available for your platform, you will need to
<a href="installation-source.html">install the source distribution</a>
instead.
</p>

<h3>Steps:</h3>
<ol>
		<li><a href="#step_dependencies">Satisfy the Dependencies</a></li>
		<li><a href="#step_run_installer">Run the Installer</a></li>
		<li><a href="#step_test">Test Your KInterbasDB Installation</a></li>
</ol>

<hr>

<!-- BEGIN COMMON SATISFY_DEPENDENCIES SECTION -->
<a name="step_dependencies"><h2>Step 1: Satisfy the Dependencies</h2></a>

<p>
KInterbasDB requires a valid combination of the dependencies in the
<a href="#dependency_list">list</a>
below.
</p>

<p>
Detailed instructions on how to install each dependency are beyond the scope
of this document; consult the dependency distributor for installation
instructions.
</p>
<p>
<strong>Satisfying the dependencies is not difficult</strong>!
For mainstream operating systems--including Windows and Linux--easily
installable binary distributions are available for
<em>all</em> of KInterbasDB's dependencies (see the download links below).
</p>

<a name="dependency_list"><h4>Dependencies:</h4></a>
<ol class="compactList" type="a">
<li>
		Operating System - one of:<br>
		<ul class="compactList">
				<li>Win32 (95, 98, ME, NT 4, 2000, XP, ...)</li>
				<li>Linux</li>
				<li>(?) Other Unix or Unix-like operating system</li>
		</ul>
</li>

<li>
		Database - one of:<br>
		<ul class="compactList">
				<li><a href="http://firebirdsql.org">Firebird<a/> 1.0 or later
						- client or server installation
						[<a href="http://sourceforge.net/project/showfiles.php?group_id=9028">download here</a>]
				</li>
				<li><a href="http://www.interbase.com">Interbase&reg;</a> 5.5 through 6.x
						- client or server installation
						[<a href="http://www.borland.com/devsupport/interbase/opensource/">download here</a>]
				</li>
				<li>(?) Interbase&reg; &gt;= 7.x</li>
		</ul>
</li>

<li><a href="http://www.python.org">Python</a>
		[<a href="http://www.python.org/download/">download here</a>]
		2.1 or later
		<br><br>
</li>

<li>
		<a href="http://www.lemburg.com/files/python/eGenix-mx-Extensions.html">eGenix.com mx Extensions for Python</a>,
		version 2.0.1 or later
		[<a href="http://www.lemburg.com/files/python/eGenix-mx-Extensions.html#Download-mxBASE">download here</a>]
		<br>
		<p class="textParagraph">
		By default, KInterbasDB uses the <code>DateTime</code> module of the
		eGenix.com <code>mx</code> Extensions to represent date and time values,
		as <a href="Python-DB-API-2.0.html#hints">recommended</a> by the
		Python DB API Specification.
		</p>
		<p class="textParagraph">
		However, it is not strictly necessary to use the <code>mx.DateTime</code>
		module to handle dates and times.
		Instructions for substituting alternatives (such as the
		<code>datetime</code> module that entered the standard library with
		Python 2.3) can be found
		<a href="usage.html#adv_param_conv_dynamic_type_translation">here</a>
		and
		<a href="usage.html#adv_param_conv_dynamic_type_translation_deferred_loading">here</a>.
		</p>
</li>

</ol>
<!-- END COMMON SATISFY_DEPENDENCIES SECTION -->

<hr>

<a name="step_run_installer"><h2>Step 2:  Run the Installer</h2></a>
<p>
Once you have successfully installed the dependencies, you may proceed with
the installation of KInterbasDB itself.
</p>

<ul>
		<li><a href="#run_installer_windows">Windows</a></li>
		<li><a href="#run_installer_other">Linux and Other Unix Variants</a></li>
</ul>

<a name="run_installer_windows"><h4>Windows</h4></a>
<p>
Binary distributions of KInterbasDB for Windows come in the form of a
conventional executable installer.  Just invoke the installer and follow
the wizard prompts.
</p>
<p style="margin-bottom: 0px;">
Because KInterbasDB is compatible with numerous versions of Python and
Interbase&reg;/Firebird, you must choose a binary distribution that matches
<em>both</em> your Python version and your database client library version.
There are three sets of Windows binary distributions of
KInterbasDB; each set offers three files, one for each of
Python 2.1, 2.2, and 2.3:
</p>
<ul style="margin-top: 0.2em;">
<li><code>kinterbasdb-<em>V.V</em>.win32-<strong>IB-5.5</strong>-py<em>V.V</em>.exe</code><br>
For use with Interbase&reg; 5.5's version of the client library
<code>gds32.dll</code>.
</li>
<li><code>kinterbasdb-<em>V.V</em>.win32-<strong>FB-1.0</strong>-py<em>V.V</em>.exe</code><br>
For use with the <code>gds32.dll</code> included with
Interbase&reg; 6.x, Firebird 1.0, or Firebird 1.5.
</li>
<li><code>kinterbasdb-<em>V.V</em>.win32-<strong>FB-1.5</strong>-py<em>V.V</em>.exe</code><br>
For use with the new <code>fbclient.dll</code> included with
Firebird 1.5.<br>
Although the previous <code>gds32.dll</code>-dependent distribution will also work
with Firebird 1.5, this distribution is preferable because
Firebird 1.5's version of <code>gds32.dll</code> is just a proxy for
<code>fbclient.dll</code>.
</li>
</ul>

<p>
Also available is a file called
<code>kinterbasdb-<em>V.V</em>.win32-all_binaries_pack.zip</code>,
which includes the binary <code>.pyd</code> files from <em>all</em> binary
Windows distributions of KInterbasDB listed above (nine sets in all).
The Python programmer can manually extract the required binaries from this
"binary pack", which makes it easier to use KInterbasDB with Python
installations that are not listed in the Windows registry, such as the Python
distribution included with the binary distribution of Zope for Windows.
</p>


<a name="run_installer_other"><h4>Linux and Other Unix Variants</h4></a>
<p>
Currently, Linux users must
<a href="installation-source.html">install the source distribution</a>
instead.  The source distribution will <em>probably</em> also install
(and function) on most other POSIX-compliant Unix variants, as long as all of
the
<a href="file:///C:/code/projects/kinterbasdb/Kinterbasdb-3.0/docs/installation-source.html#step_dependencies">dependencies</a> are also installed
and functional.
</p>
<p>
Because the KInterbasDB source distribution supports the
standard Python package installation facility
(<a href="http://www.python.org/sigs/distutils-sig/"><code>distutils</code></a>),
installing the source distribution on a typical Linux system is downright
easy.
</p>

<hr>

<a name="step_test"><h2>Step 3: Test Your KInterbasDB Installation</h2></a>
<p>
<span class="XXX_ADDRESS_THIS">XXX</span>
A substantial portion of a kinterbasdb test suite has been written; it will
be published with kinterbasdb-3.1 final.
</p>
<p>
In the meantime, verify the integrity of your KInterbasDB installation by
opening a command prompt and issuing the following command:<br>
<code>python -c "import kinterbasdb"</code><br>
</p>
<p>
If the import attempt does not encounter any errors, you are finished.
Next, consider reading the <a href="usage.html">KInterbasDB Usage Guide</a>.
</p>

<p>
You should not encounter any errors at this stage since you have
already completed the compilation and installation steps successfully.
If you do, please report them to the
<a href="http://sourceforge.net/forum/forum.php?forum_id=30917">KInterbasDB Forum</a>.
</p>

<hr>

<a href="index.html">Table of Contents</a>

</body>
</html>