Skip to main content

Python 3 module for accessing LDAP directory servers.

Project description

PyPI Version GitHub Action Build Status Azure Pipelines Status AppVeyor CI Build Status Coverage Status Documentation Status GitHub License

This is a module for handling LDAP operations in Python. Uses libldap2 on Unix platforms and WinLDAP on Microsoft Windows. LDAP entries are mapped to a special Python case-insensitive dictionary, tracking the changes of the dictionary to modify the entry on the server easily.

Supports only Python 3.7 or newer, and LDAPv3.


  • Uses LDAP libraries (OpenLDAP and WinLDAP) written in C for faster processing.

  • Simple pythonic design.

  • Implements an own dictionary-like object for mapping LDAP entries that makes easier to add and modify them.

  • Works with various asynchronous library (like asyncio, gevent).

Requirements for building

  • python3.7-dev or newer

  • libldap2-dev

  • libsasl2-dev

  • libkrb5-dev or heimdal-dev (optional)


Documentation is available online with a simple tutorial.


Simple search and modify:

import bonsai

client = bonsai.LDAPClient("ldap://localhost")
client.set_credentials("SIMPLE", user="cn=admin,dc=bonsai,dc=test", password="secret")
with client.connect() as conn:
    res ="ou=nerdherd,dc=bonsai,dc=test", 2, "(cn=chuck)")
    res[0]['givenname'] = "Charles"
    res[0]['sn'] = "Carmichael"

Using with asyncio:

import asyncio
import bonsai

async def do():
    client = bonsai.LDAPClient("ldap://localhost")
    client.set_credentials("DIGEST-MD5", user="admin", password="secret")
    async with client.connect(is_async=True) as conn:
        res = await"ou=nerdherd,dc=bonsai,dc=test", 2)
        who = await conn.whoami()


The changelog is available here and included in the documentation as well.


Any contributions and advices are welcome. Please report any issues at the GitHub page.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bonsai-1.5.1.tar.gz (149.6 kB view hashes)

Uploaded source

Built Distributions

bonsai-1.5.1-cp311-cp311-win_amd64.whl (86.8 kB view hashes)

Uploaded cp311

bonsai-1.5.1-cp311-cp311-win32.whl (80.9 kB view hashes)

Uploaded cp311

bonsai-1.5.1-cp310-cp310-win_amd64.whl (86.8 kB view hashes)

Uploaded cp310

bonsai-1.5.1-cp310-cp310-win32.whl (80.9 kB view hashes)

Uploaded cp310

bonsai-1.5.1-cp39-cp39-win_amd64.whl (86.8 kB view hashes)

Uploaded cp39

bonsai-1.5.1-cp39-cp39-win32.whl (80.9 kB view hashes)

Uploaded cp39

bonsai-1.5.1-cp38-cp38-win_amd64.whl (86.8 kB view hashes)

Uploaded cp38

bonsai-1.5.1-cp38-cp38-win32.whl (80.9 kB view hashes)

Uploaded cp38

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page