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
|
Installing :mod:`repoze.bfg`
============================
How To Install
--------------
You will need `Python <http://python.org>`_ version 2.4 or better to
run :mod:`repoze.bfg`. Development of :mod:`repoze.bfg` is done
primarily under Python 2.4, so that version is recommended.
:mod:`repoze.bfg` does *not* run under any version of Python before
2.4, and does *not* run under Python 3.X.
.. warning:: To succesfully install :mod:`repoze.bfg`, you will need
an environment capable of compiling C code. See the documentation
about installing, e.g. ``gcc`` for your system. Additionally, the
Python development libraries for your Python version will need to
be installed and the ``lixbml2`` and ``libxslt`` development
libraries will need to be installed. These requirements are often
satisfied by installing the ``python-devel``, ``libxml2-devel`` and
``libxslt-devel`` packages into your system. You will also need
:term:`setuptools` installed on within your Python system in order
to run the ``easy_install`` command.
At the time of this writing, ``repoze.bfg`` will not install on
Windows systems unless you have development tools (e.g. *Visual C++*)
installed.
.. note:: If you'd like to help produce and maintain a version of
:mod:`repoze.bfg` that works on Windows, we'd love to hear from
you. There's nothing intrinsic about :mod:`repoze.bfg` that would
prevent it from running on Windows, but none of the current
developers use the platform. Please contact us via the `repoze.dev
maillist <http://lists.repoze.org/listinfo/repoze-dev>`_ if you'd
like to try to tackle the job of compilation and maintenance.
It is advisable to install :mod:`repoze.bfg` into a :term:`virtualenv`
in order to obtain isolation from any "system" packages you've got
installed in your Python version (and likewise, to prevent
:mod:`repoze.bfg` from globally installing versions of packages that
are not compatible with your system Python).
After you've got the requisite dependencies installed, you may install
:mod:`repoze.bfg` into your Python environment using the following
command::
$ easy_install -i http://dist.repoze.org/lemonade/dev/simple repoze.bfg
.. note:: If you can't get :mod:`repoze.bfg` installed using
``easy_install`` because ``lxml`` fails to compile on your system,
you can try the `repoze.bfg buildout
<http://svn.repoze.org/buildouts/repoze.bfg/trunk/README.txt>`_.
This installation mechanism builds known-compatible ``libxml2`` and
``libxslt`` from source and causes ``lxml`` to link against these
instead of your system packages, as version incompatibilities
between system packages and ``lxml`` versions are typically to
blame for compilation problems.
What Gets Installed
-------------------
When you ``easy_install`` :mod:`repoze.bfg`, various Zope libraries,
WebOb, Paste, PasteScript, and PasteDeploy libraries are installed.
Additionally, as shown in the next section, PasteScript (aka *paster*)
templates will be registered that make it easy to start a new
:mod:`repoze.bfg` project.
|