Skip to content

Commit a4507a4

Browse files
author
Greg Turnquist
committed
Merge branch 'installation' into 1.1.x
2 parents 34a30e4 + fec3ce8 commit a4507a4

File tree

1 file changed

+57
-2
lines changed

1 file changed

+57
-2
lines changed

docs/reference/src/overview.xml

+57-2
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,15 @@
124124
<section id="overview-support">
125125
<title>Support</title>
126126

127+
<section id="overview-support-book">
128+
<title>Spring Python 1.1 book</title>
129+
130+
<para>You can order either a printed or electronic version of the <ulink url="https://www.packtpub.com/create-powerful-versatile-spring-python-1-1-applications/book">Spring Python 1.1 book</ulink>
131+
written by project creator Greg Turnquist. This contains a lot of code samples, diagrams,
132+
and descriptions of the concepts behind Spring Python. This book was completed right as
133+
Spring Python 1.1 was released, and 1.2.x was started, so it contains up-to-date information on the project.</para>
134+
135+
</section>
127136
<section id="overview-support-forums">
128137
<title>Forums and Email</title>
129138

@@ -171,11 +180,57 @@ svn co https://src.springframework.org/svn/se-springpython-py/trunk/springpython
171180

172181
</para>
173182

174-
<para>That will create a new <emphasis>springpython</emphasis> folder. This includes both the source code and
183+
<para>That will create a new <emphasis role="bold">springpython</emphasis> folder. This includes both the source code and
175184
the demo applications (PetClinic and SpringWiki).</para>
176185

177186
<para>You can browse the code at <ulink url="https://fisheye.springframework.org/browse/se-springpython-py"/>.</para>
178187
</section>
188+
189+
<section id="overview-installation">
190+
<title>Installation</title>
191+
192+
<para>This section is focused on helping you set up Spring Python.</para>
193+
194+
<orderedlist numeration="arabic">
195+
<listitem>Go to <ulink url="http://s3browse.com/explore/dist.springframework.org/release/EXT/se-springpython-py/">Spring's download site for Spring Python</ulink>.</listitem>
196+
<listitem>Click on Spring Python.</listitem>
197+
<listitem>Download <emphasis role="bold">springpython-[release].tar.gz</emphasis> to get the core library.</listitem>
198+
<listitem>Unpack the tarball, and go to the directory containing setup.py. (NOTE: This has been tested on Mac OSX 10.5/10.6, and Ubuntu Linux 9.04+)</listitem>
199+
<listitem>Type <emphasis role="bold">python setup.py install</emphasis> to install Spring Python. (NOTE: You may need administrative power to do this!)</listitem>
200+
</orderedlist>
201+
202+
<para>This installs the core library of Spring Python. Version 1.1 supports Python 2.4+ (but not Python 3). To use other features like CherryPy and Pyro, you need to execute some of the following extra steps.</para>
203+
204+
<orderedlist numeration="arabic">
205+
<listitem>Go to <ulink url="http://pypi.python.org/pypi/setuptools">setuptools</ulink> and follow the steps for your platform to install setuptools.</listitem>
206+
<listitem>Install CherryPy for web app development by typing <emphasis role="bold">easy_install cherrypy</emphasis>. This should install CherryPy 3.2.</listitem>
207+
<listitem>Install Pyro for RPC functionality by typing <emphasis role="bold">easy_install pyro</emphasis>. This should install Pyro (not Pyro 3).</listitem>
208+
<listitem>Install PyYAML if you want the YAML-based IoC configuratin options by typing <emphasis role="bold">easy_install pyyaml</emphasis>.</listitem>
209+
<listitem>Install MySQLdb by typing <emphasis role="bold">easy_install mysql-python</emphasis>.</listitem>
210+
<listitem>Install PySqlite by typing <emphasis role="bold">easy_install pysqlite</emphasis>.</listitem>
211+
<listitem>Install ElementTree if you are using a version of Python that doesn't incluee it by default by typing <emphasis role="bold">easy_install elementtree</emphasis>.</listitem>
212+
</orderedlist>
213+
214+
<para>You may not need all of these libraries. Determine what you need and then install it.</para>
215+
216+
<para>Another feature which is very useful, is to install everything (including Spring Python) inside a virtual environment. You can read
217+
<ulink url="http://iamzed.com/2009/05/07/a-primer-on-virtualenv/">A Primer on virtualenv</ulink> to get an introduction to virtualenv. After
218+
installing easy_install, you simply type <emphasis role="bold">easy_install virtualenv</emphasis> to install this tool. From there, you can create an virtual
219+
installation by typing <emphasis role="bold">virtualenv --no-site-packages name_of_your_folder</emphasis>. On UNIX systems, To activate it, type
220+
<emphasis role="bold">. name_of_your_folder/bin/activate</emphasis>. The virtualenv will manipulate your path settings and point you to a different location of the python
221+
executable, a different easy_install and pip, and a different PYTHON_PATH. Essentially, python setup.py foobar will install into this folder
222+
you just created instead of the system version. For isolation, this is a highly recommended way to install everything.</para>
223+
224+
<note>
225+
<title>Using easy_install and pip vs. OS package installation tools</title>
226+
227+
<para>A lot of operating systems, like Ubuntu Linux, offer the same python libraries through tools like RPM, APT, etc.
228+
Due to personal experience, it is recommended to NOT use these when it comes to using Spring Python. Using OS package management
229+
can result in library upgrades when performing system upgrades. Using virtualenv is the best way to control the version of
230+
library installed and also shield your system from system upgrades.</para>
231+
</note>
232+
233+
</section>
179234

180235
<section id="overview-license">
181236
<title>Licensing</title>
@@ -233,7 +288,7 @@ svn co https://src.springframework.org/svn/se-springpython-py/trunk/springpython
233288
url="http://lists.springsource.com/listmanager/listinfo/springpython-users">
234289
springpython-developer</ulink> mailing list. That way, you'll get notified about
235290
big items as well be on the inside for important developments that may or may
236-
not get published to the web site. <emphasis>NOTE: Use the springsource list, NOT the
291+
not get published to the web site. <emphasis role="bold">NOTE: Use the springsource list, NOT the
237292
sourceforge one.</emphasis></para>
238293
</listitem>
239294
<listitem>

0 commit comments

Comments
 (0)