Metadata-Version: 1.1
Name: ldif
Version: 4.0.0
Summary: generate and parse LDIF data (see RFC 2849).
Home-page: https://github.com/abilian/ldif
Author: Abilian SAS
Author-email: dev@abilian.com
License: BSD
Description: ldif - generate and parse LDIF data (see `RFC 2849`_).
        ======================================================
        
        This is a fork of the ``ldif`` module from `python-ldap`_ with python3/unicode
        support.
        
        One of its benefits is that it's a pure-python package (you don't depend
        on the ``libldap2-dev`` (or similar) package that needs to be installed on
        your laptop / test machine / production server.
        
        See the first entry in CHANGES.rst for a more complete list of
        differences.
        
        This package only support Python 3 (>= 3.6, actually).
        
        
        Usage
        -----
        
        Parse LDIF from a file (or ``BytesIO``)::
        
            from ldif import LDIFParser
            from pprint import pprint
        
            parser = LDIFParser(open('data.ldif', 'rb'))
            for dn, entry in parser.parse():
                print('got entry record: %s' % dn)
                pprint(record)
        
        
        Write LDIF to a file (or ``BytesIO``)::
        
            from ldif import LDIFWriter
        
            writer = LDIFWriter(open('data.ldif', 'wb'))
            writer.unparse('mail=alice@example.com', {
                'cn': ['Alice Alison'],
                'mail': ['alice@example.com'],
                'objectclass': ['top', 'person'],
            })
        
        Unicode support
        ---------------
        
        The stream object that is passed to parser or writer must be an ascii byte
        stream.
        
        The spec allows to include arbitrary data in base64 encoding or via URL. There
        is no way of knowing the encoding of this data. To handle this, there are two
        modes:
        
        By default, the ``LDIFParser`` will try to interpret all values as UTF-8 and
        leave only the ones that fail to decode as bytes. But you can also pass an
        ``encoding`` of ``None`` to the constructor, in which case the parser will not
        try to do any conversion and return bytes directly.
        
        
        .. _RFC 2849: https://tools.ietf.org/html/rfc2849
        .. _python-ldap: http://www.python-ldap.org/
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: BSD License
Classifier: Intended Audience :: Developers
Classifier: Topic :: System :: Systems Administration :: Authentication/Directory :: LDAP
