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

.. _LDAP: https://en.wikipedia.org/wiki/Ldap
.. _Python: https://www.python.org/
.. _OpenLDAP: https://www.openldap.org/
.. _LDIF: https://en.wikipedia.org/wiki/LDIF


Get it!
-------

:ref:`Installation instructions <installing>` 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`_.

.. _subscribe or unsubscribe: https://mail.python.org/mailman/listinfo/python-ldap
.. _list archive: https://mail.python.org/pipermail/python-ldap/


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`_.

.. _Read the Docs: https://python-ldap.readthedocs.io/en/latest/
.. _GitHub release page: https://github.com/python-ldap/python-ldap/releases


Contents
--------

.. toctree::
   :maxdepth: 2

   installing.rst
   bytes_mode.rst
   reference/index.rst
   resources.rst
   contributing.rst
   faq.rst


Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
