Installation and configuration¶

Installation is straightforward and can be done via a package manager or from the source.

Installation with a package manager¶

You need the pip package (or another package manager that can download and install from pyPI) to install ldap3. Then you can download and install the ldap3 library directly from pyPI:

This library has only one dependence on the pyasn1 module, You can install it or let the installer do it for you.

If you need to access a server with the Kerberos SASL authentication mechanism you must install the gssapi package.

ldap3 includes a backport (from Python 3.4.3) of ssl.check_hostnames to be used on older (version get_config_parameter() and set_config_parameter() functions in the ldap3 namespace to get and set the configurable parameters at runtime.

Importing objects and constants¶

All objects and constants needed to use the ldap3 library can be imported from the ldap3 namespace:

Library errors¶

You can deal with errors in two different ways. By default in synchronous strategies each LDAP operation returns a True/False value that specify if the operation has been successful or not. In case of failures you can check the error description in the `last_error` attribute of the Connection object. In some cases an exception of the custom hierarchy starting from the `LDAPExceptionError` class is raised with a description of the error condition in the args attribute.

If you prefer to deal always with Exceptions you can set the raise_exceptions attribute to True in the Connection object definition. From now on the Connection will raise exceptions for all operations that return result codes different from RESULT_SUCCESS , RESULT_COMPARE_FALSE , RESULT_COMPARE_TRUE , RESULT_REFERRAL .

Communication exceptions have multiple inheritance either from `LDAPCommunicationError` and the specific socket exception.

Exceptions are defined in the ldap3.core.exceptions package.

© Copyright 2020, Giovanni Cannata Revision 78c449dd .

Installing python-ldap¶

Installing from PyPI¶

The preferred point for downloading the “official” source distribution is the PyPI repository which supports installing via pip. For example:

For installing from PyPI, you will need the same Build prerequisites as when installing from source.

We do not currently provide pre-built packages (wheels).

Furthermore, python-ldap requires the modules pyasn1 and pyasn1-modules. pip will install these automatically.

Pre-built Binaries¶

Because distributions seem to be all over the place, this page tries to list all the current ones we know of.

Note that the python-ldap team is not responsible for the binary packages except the sources you can grab from the PyPI page. Also note that binary packages are most times not up to date. If you experience troubles with a binary package, it would be nice if you try to build a recent version of python-ldap before submitting a bug report to make sure you did not hit a problem already fixed in recent releases.

openSUSE Linux¶

Ships with python-ldap and there’s an additional download repository which contains builds of latest releases (see also OBS package).

Debian Linux¶

Have a look into the Debian Package Tracker to get up to date information which versions are available.

Windows¶

Unofficial packages for Windows are available on Christoph Gohlke’s page.

FreeBSD¶

The CVS repository of FreeBSD contains the package py-ldap

macOS¶

You can install directly with pip:

Installing from Source¶

python-ldap is built and installed using the Python setuptools. From a source repository:

If you have more than one Python interpreter installed locally, you should use the same one you plan to use python-ldap with.

Further instructions can be found in Setuptools documentation .

Build prerequisites¶

The following software packages are required to be installed on the local system when building python-ldap:

• Python version 2.7, or 3.4 or later including its development files
• C compiler corresponding to your Python version (on Linux, it is usually gcc )
• OpenLDAP client libs version 2.4.11 or later; it is not possible and not supported to build with prior versions.
• OpenSSL (optional)
• Cyrus SASL (optional)
• Kerberos libraries, MIT or Heimdal (optional)

How to install python-ldap on a python 2.7 virtualenv on windows without compiling

I am using Windows as my main python 2.7 development environment and I want to install python-ldap on a virtual environment.

The python-ldap package needs compiling 🙁 and of course I can’t compile it in my environment. So I tried finding binaries in order to install them in my virtual environment through easy_install (FYI you can do easy_install package.exe and the package will be installed). I found the distributed binaries here: https://pypi.python.org/pypi/python-ldap/

Unfortunately, they give only .msi packages for python 2.7 . Why do people use .msi ? MSI CANNOT BE INSTALLED THROUGH easy_install. I HATE MSI %$#$^#$^#$

Yes I can install the .msi package by executing it but it will be installed in the global python packages and not on my virtual environment!

Please, can anybody help me ? I remember having this exact problem in a previous project and I had to develop it outside of a virtual environment — but I cannot do this now 🙁

Update: I installed python-ldap system-wide and copied the directories ldap and python_ldap-2.4.10-py2.7.egg-info from PYTHON_GLOBAL\Lib\site-packages to VIRTUALENV\Lib\site-packages and seems to be working now. However I really don’t like that solution so I won’t answer my question with that. Also, Alexander’s comment on recreating my virtualenv with —system-site-packages probably will be working but this means that I’d need to uninstall a lot of my global packages packages and then install again my virtual packages etc and in general it’s not DRY 🙁

Update 2: After trying cgohlke’s suggestion, I saw that the contents of the MSI were the two directories I mentioned above along with the files dsml.py, ldapurl.py and ldif.py. So I also copied this to my VIRTUALENV\Lib\site-packages. Now I believe that the installation is ok :). But I believe that cgohlke’s is the best one — just use msiexec.exe to extract the contents of the msi directly to your VIRTUALENV.

gohlke/pythonlibs/#python-ldap. In there you will be able to find .EXE install packages for python-ldap and LOTS of others. So finally by downloading these you’ll be able to easy_install them in your virtualenv!

Python ldap install windows

python-ldap: LDAP client API for Python

What is python-ldap?

python-ldap provides an object-oriented API to access LDAP directory servers from Python programs. Mainly it wraps the OpenLDAP client libs for that purpose.

Additionally the package contains modules for other LDAP-related stuff (e.g. processing LDIF, LDAPURLs, LDAPv3 sub-schema, etc.).

Not included: Direct BER support

See INSTALL for version compatibility

See TODO for planned features. Contributors welcome.

For module documentation, see:

Quick usage example:

See directory Demo/ of source distribution package for more example code.

Author(s) contact and documentation:

If you are looking for help, please try the mailing list archives first, then send a question to the mailing list. Be warned that questions will be ignored if they can be trivially answered by referring to the documentation.

If you are interested in helping, please contact the mailing list. If you want new features or upgrades, please check the mailing list archives and then enquire about any progress.

Thanks to Konstantin Chuguev and Steffen Ries for working on support for OpenLDAP 2.0.x features.

Thanks to Michael Stroeder for the modules ldif , ldapurl , ldap/schema/*.py , ldap/*.py and ldap/controls/*.py .

Thanks to Hans Aschauer for the C wrapper schema and SASL support.

Thanks to Mauro Cicognini for the WIN32/MSVC6 bits, and the pre-built WIN32 ldap.pyd .

Thanks to Waldemar Osuch for contributing the new-style docs based on reStructuredText.

Thanks to Torsten Kurbad for the easy_install support.

Thanks to James Andrewartha for significant contribution to Doc/*.tex .

Thanks to Rich Megginson for extending support for LDAPv3 controls and adding support for LDAPv3 extended operations.

Thanks to Peter Gietz, DAASI for funding some control modules.

Thanks to Chris Mikkelson for various fixes and ldap.syncrepl.

These very kind people have supplied patches or suggested changes:

• Federico Di Gregorio
• John Benninghoff
• Donn Cave
• Jason Gunthorpe
• gurney_j
• Eric S. Johansson
• David Margrave
• Uche Ogbuji
• Neale Pickett
• Blake Weston
• Wido Depping
• Deepak Giridharagopal
• Ingo Steuwer
• Andreas Hasenack
• Matej Vela

These people contributed to Python 3 porting (at https://github.com/pyldap/):

• ​A. Karl Kornel
• Alex Willmer
• Aymeric Augustin
• Bradley Baetz
• Christian Heimes
• Dirk Mueller
• Jon Dufresne
• Martin Basti
• Miro Hrončok
• Paul Aurich
• Petr Viktorin
• Pieterjan De Potter
• Raphaël Barrois
• Robert Kuska
• Stanislav Láznička
• Tobias Bräutigam
• Tom van Dijk
• Wentao Han
• William Brown

Thanks to all the guys on the python-ldap mailing list for their contributions and input into this package.

Thanks! We may have missed someone: please mail us if we have omitted your name.

Unable to install on Windows 10: fatal error C1083: Cannot open include file: ‘lber.h’ #243

Comments

AminMkh commented Sep 26, 2018 •

Unable to install on Windows 10, I tried

Issue description:
Whenever I run: pip install python-ldap
I get the following:

c:\users\user\appdata\local\temp\pip-install-652a07b0\python-ldap\modules\constants.h(7): fatal error C1083: Cannot open include file: ‘lber.h’: No such file or directory
error: command ‘C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\VC\Tools\MSVC\14.15.26726\bin\HostX86\x86\cl.exe’ failed with exit status 2

Command «»c:\program files (x86)\python36-32\python.exe» -u -c «import setuptools, tokenize;file=’C:\Users\user\AppData\Local\Temp\pip-install-652a07b0\python-ldap\setup.py’;f=getattr(tokenize, ‘open’, open)(file);code=f.read().replace(‘\r\n’, ‘\n’);f.close();exec(compile(code, file, ‘exec’))» install —record C:\Users\user\AppData\Local\Temp\pip-record-09ceypm_\install-record.txt —single-version-externally-managed —compile» failed with error code 1 in C:\Users\user\AppData\Local\Temp\pip-install-652a07b0\python-ldap\

pyldap-3.0.0-py2.py3-none-any.whl is not a supported wheel on this platform.

• Also looked into requirements: https://www.python-ldap.org/en/latest/installing.html#build-prerequisites
  I downloaded the OpenLDAP client libs but didn’t know where to place it’s folder ?

Steps to reproduce:
pip install python-ldap

Operating system: Windows 10, version 1803, OS Build 171134.285
Python version: Python 3.6.5

python-ldap version: None

Any ideas how to proceed ?

The text was updated successfully, but these errors were encountered: