summaryrefslogtreecommitdiffstats
path: root/docs/install.rst
blob: 7b1e4435bad12076f3bb137e043a792b3b614a29 (plain)
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
Installation
============

You will need `Python <http://python.org>`_ version 2.4 or better to
run :mod:`Products.LDAPConnector`.  Development of 
:mod:`Products.LDAPConnector` is done primarily under Python 2.7, so 
that version is recommended.

.. warning:: To successfully install :mod:`Products.LDAPConnector`, 
   you will need :term:`setuptools` installed on your Python system 
   in order to run the ``easy_install`` command.

It is advisable to install :mod:`Products.LDAPConnector` 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:`Products.LDAPConnector` 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:`Products.LDAPConnector` into your Python environment using the 
following command::

  $ easy_install Products.LDAPConnector

If you use :mod:`zc.buildout` you can add :mod:`Products.LDAPConnector`
to the necessary ``eggs`` section to have it pulled in automatically.

When you ``easy_install`` :mod:`Products.LDAPConnector`, the
:term:`python-ldap` libraries are installed if they are not present.