diff --git a/README b/README new file mode 100644 index 0000000..981f264 --- /dev/null +++ b/README @@ -0,0 +1,102 @@ +--------------------------------------- +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 compability + +See TODO for planned features. Contributors welcome. + +For module documentation, see: + + http://www.python-ldap.org/ + +Quick usage example: + import ldap + l = ldap.initialize("ldap://my_ldap_server.my_domain") + l.simple_bind_s("","") + l.search_s("o=My Organisation, c=AU", ldap.SCOPE_SUBTREE, "objectclass=*") + +See directory Demo/ of source distribution package for more +example code. + +Author(s) contact and documentation: + + http://www.python-ldap.org/ + + 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. + +Acknowledgements: + + 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 + + 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. + +$Id: README,v 1.25 2011/10/26 18:43:21 stroeder Exp $