Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 130 lines (111 sloc) 5.593 kb
17aed24 Sam Ruby Documentation updates
authored
1 <!DOCTYPE html PUBLIC
2 "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN"
3 "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml">
5 <head>
6 <script type="text/javascript" src="docs.js"></script>
7 <link rel="stylesheet" type="text/css" href="docs.css"/>
8 <title>Venus Installation</title>
9 </head>
10 <body>
11 <h2>Installation</h2>
12 <p>Venus has been tested on Linux, and Mac OSX, and Windows.</p>
13
14 <p>You'll need at least Python 2.2 installed on your system, we recommend
15 Python 2.4 though as there may be bugs with the earlier libraries.</p>
16
4a777e1 Sam Ruby Documentation nits
authored
17 <p>Everything Pythonesque Planet needs to provide basic operation should be
18 included in the distribution. Some optional features may require
19 additional libraries, for example:</p>
17aed24 Sam Ruby Documentation updates
authored
20 <ul>
21 <li>Usage of XSLT requires either
22 <a href="http://xmlsoft.org/XSLT/xsltproc2.html">xsltproc</a>
23 or <a href="http://xmlsoft.org/XSLT/python.html">python-libxslt</a>.</li>
24 <li>The current interface to filters written in non-templating languages
25 (e.g., python) uses the
26 <a href="http://docs.python.org/lib/module-subprocess.html">subprocess</a>
27 module which was introduced in Python 2.4.</li>
28 <li>Usage of FOAF as a reading list requires
29 <a href="http://librdf.org/">librdf</a>.</li>
30 </ul>
31
13d4731 Work on docs:
Chris Dolan authored
32 <h3>General Instructions</h3>
33
34 <p>
35 These instructions apply to any platform. Check the instructions
36 below for more specific instructions for your platform.
37 </p>
17aed24 Sam Ruby Documentation updates
authored
38
39 <ol>
40 <li><p>If you are reading this online, you will need to
13d4731 Work on docs:
Chris Dolan authored
41 <a href="../index.html">download</a> and extract the files into a folder somewhere.
17aed24 Sam Ruby Documentation updates
authored
42 You can place this wherever you like, <code>~/planet</code>
43 and <code>~/venus</code> are good
44 choices, but so's anywhere else you prefer.</p></li>
45 <li><p>This is very important: from within that directory, type the following
46 command:</p>
47 <blockquote><code>python runtests.py</code></blockquote>
48 <p>This should take anywhere from a one to ten seconds to execute. No network
49 connection is required, and the script cleans up after itself. If the
50 script completes with an "OK", you are good to go. Otherwise stopping here
51 and inquiring on the
52 <a href="http://lists.planetplanet.org/mailman/listinfo/devel">mailing list</a>
53 is a good idea as it can save you lots of frustration down the road.</p></li>
54 <li><p>Make a copy of one of the <code>ini</code> the files in the
55 <a href="../examples">examples</a> subdirectory,
56 and put it wherever you like; I like to use the Planet's name (so
57 <code>~/planet/debian</code>), but it's really up to you.</p></li>
58 <li><p>Edit the <code>config.ini</code> file in this directory to taste,
59 it's pretty well documented so you shouldn't have any problems here. Pay
60 particular attention to the <code>output_dir</code> option, which should be
61 readable by your web server. If the directory you specify in your
62 <code>cache_dir</code> exists; make sure that it is empty.</p></li>
63 <li><p>Run it: <code>python planet.py pathto/config.ini</code></p>
64 <p>You'll want to add this to cron, make sure you run it from the
65 right directory.</p></li>
66 <li><p>(Optional)</p>
67 <p>Tell us about it! We'd love to link to you on planetplanet.org :-)</p></li>
68 <li><p>(Optional)</p>
69 <p>Build your own themes, templates, or filters! And share!</p></li>
70 </ol>
13d4731 Work on docs:
Chris Dolan authored
71
0df474c Sam Ruby Support backlevel versions of Python
authored
72 <h3 id="macosx">Mac OS X and Fink Instructions</h3>
13d4731 Work on docs:
Chris Dolan authored
73
74 <p>
75 The <a href="http://fink.sourceforge.net/">Fink Project</a> packages
76 various open source software for MacOS. This makes it a little easier
77 to get started with projects like Planet Venus.
78 </p>
79
80 <p>
81 Note: in the following, we recommend explicitly
82 using <code>python2.4</code>. As of this writing, Fink is starting to
83 support <code>python2.5</code> but the XML libraries, for example, are
84 not yet ported to the newer python so Venus will be less featureful.
85 </p>
86
87 <ol>
88 <li><p>Install the XCode development tools from your Mac OS X install
89 disks</p></li>
90 <li><p><a href="http://fink.sourceforge.net/download/">Download</a>
91 and install Fink</p></li>
92 <li><p>Tell fink to install the Planet Venus prerequisites:<br />
93 <code>fink install python24 celementtree-py24 bzr-py24 libxslt-py24
94 libxml2-py24</code></p></li>
95 <li><p><a href="../index.html">Download</a> and extract the Venus files into a
96 folder somewhere</p></li>
97 <li><p>Run the tests: <code>python2.4 runtests.py</code><br /> This
98 will warn you that the RDF library is missing, but that's
99 OK.</p></li>
100 <li><p>Continue with the general steps above, starting with Step 3. You
101 may want to explicitly specify <code>python2.4</code>.</p></li>
102 </ol>
103
0df474c Sam Ruby Support backlevel versions of Python
authored
104 <h3 id="ubuntu">Ubuntu Linux (Edgy Eft) instructions</h3>
405290a Sam Ruby additional logging and installation information
authored
105
106 <p>Before starting, issue the following command:</p>
0df474c Sam Ruby Support backlevel versions of Python
authored
107
108 <blockquote><pre>sudo apt-get install bzr python2.4-librdf</pre></blockquote>
109
a590d13 verbosus Added note on pywin32 dependency for Windows, added pointer to Django te...
verbosus authored
110 <h3 id="windows">Windows instructions</h3>
111
112 <p>
113 htmltmpl templates (and Django too, since it currently piggybacks on
114 the htmltmpl implementation) on Windows require
115 the <a href="http://sourceforge.net/projects/pywin32/">pywin32</a>
116 module.
117 </p>
118
0df474c Sam Ruby Support backlevel versions of Python
authored
119 <h3 id="python22">Python 2.2 instructions</h3>
120
121 <p>If you are running Python 2.2, you may also need to install <a href="http://pyxml.sourceforge.net/">pyxml</a>. If the
122 following runs without error, you do <b>not</b> have the problem.</p>
123 <blockquote><pre>python -c "__import__('xml.dom.minidom').dom.minidom.parseString('&lt;entry xml:lang=\"en\"/&gt;')"</pre></blockquote>
124 <p>Installation of pyxml varies by platform. For Ubuntu Linux (Dapper Drake), issue the following command:</p>
125
126 <blockquote><pre>sudo apt-get install python2.2-xml</pre></blockquote>
405290a Sam Ruby additional logging and installation information
authored
127
17aed24 Sam Ruby Documentation updates
authored
128 </body>
129 </html>
Something went wrong with that request. Please try again.