# python-ldap

## What is python-ldap?

python-ldap provides an object-oriented API to access LDAP directory servers from Python programs.

For LDAP operations the module wraps OpenLDAP’s client library, libldap.

Additionally, the package contains modules for other LDAP-related stuff:

> - LDIF parsing and generation

> - LDAP URLs

> - LDAPv3 subschema

## Get it!

Installation instructions are available for several platforms.

Source code can be obtained using Git:

    git clone https://github.com/python-ldap/python-ldap

## Mailing list

Discussion about the use and future of python-ldap occurs in the `python-ldap@python.org` mailing list.

You can subscribe or unsubscribe to this list or browse the list archive.

## Documentation

The documentation for python-ldap 3.x is hosted at Read the Docs.

You can switch between versions of the library, or download PDF or HTML versions for offline use, using the sidebar on the right.

Documentation for some older versions is available for download at the GitHub release page.

## Contents

- Installing python-ldap
  - Installing from PyPI
  - Pre-built Binaries
  - Installing from Source
  - Build prerequisites
  - `setup.cfg`
- Bytes/text management
  - Historical note
- python-ldap Reference Documentation
  - `ldap` LDAP library interface module
  - `ldap.asyncsearch` Stream-processing of large search results
  - `ldap.controls` High-level access to LDAPv3 extended controls
  - `ldap.dn` LDAP Distinguished Name handling
  - `ldap.extop` High-level access to LDAPv3 extended operations
  - `ldap.filter` LDAP filter handling
  - `ldap.modlist` Generate modify lists
  - `ldap.resiter` Generator for stream-processing of large search results
  - `ldap.schema` Handling LDAPv3 schema
  - `ldap.syncrepl` Implementation of a syncrepl consumer
  - `ldap.sasl` SASL Authentication Methods
  - `ldif` LDIF parser and generator
  - `ldapurl` LDAP URL handling
  - `slapdtest` Spawning test instances of OpenLDAP’s slapd server
- Third-party documentation
  - Python LDAP Applications articles by Matt Butcher
  - LDAP Programming in Python
  - RFC 1823
  - LDAPEXT draft
  - OpenLDAP
  - VSLDAP
- Contributing to python-ldap
  - Communication
  - Contributing code
  - Additional tests and scripts
  - Instructions for core committers
  - Instructions for release managers
- python-ldap FAQ
  - Project
  - Usage
  - Installing
  - Historic

## Indices and tables

- Index

- Module Index

- Search Page