diff --git a/README.md b/README.md index 030c0484e23bc2d8b30d80e1ba878b098dc46ab9..08d581c659b62b954e402f920913bfe0bb54bc71 100644 --- a/README.md +++ b/README.md @@ -5,4 +5,5 @@ Python library that implements the socketserver.BaseRequestHandler interface for LDAP. It provides stubs for all operations (BIND, SEARCH, ...). Overwrite the stubs you need to provide actual functionality. -**Early prototype, API not stable yet, do not rely on it!** +See the [documentation](https://uffd.pages.git.cccv.de/python-ldapserver) for +further details. diff --git a/docs/conf.py b/docs/conf.py index 066df16fe3f266f7088d7368807e1763c63dc6cd..008d3602f64a1686473caa4bdb4621931cb5d6cb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -37,8 +37,8 @@ intersphinx_mapping = { 'python': ('https://docs.python.org/3', None), } -smv_tag_whitelist = r'^v[0-9]+\.[0-9]+\.[0-9]+$' -smv_branch_whitelist = r'^master$' +smv_tag_whitelist = None +smv_branch_whitelist = r'^(master|v[0-9]+\.[0-9]+\.x)$' smv_remote_whitelist = r'^origin$' #smv_released_pattern = r'^tags/v[0-9]+\.[0-9]+\.[0-9]+$' smv_prefer_remote_refs = False diff --git a/docs/index.rst b/docs/index.rst index c33ca85397c3c0aa3fb0a4fc68f8eb28604fef68..b4cc2b3b51673c7f67f9888f2ff98d3605847826 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,23 @@ -Python LDAP Server -================== +Welcome to python-ldapserver's documentation +============================================ + +python-ldapserver is a self-contained pure Python 3 library for implementing special-purpose LDAPv3 servers. +It aims for full RFC4510 compliance. + +A typical use case is glue code for integrating LDAP clients (e.g. web applications that use LDAP for authentication and user synchonization) with non-LDAP data sources (e.g. HTTP APIs). + +The project is in an early stage of development. +You can use it to write a fully-functional and stable read-only LDAP server. +However, expect significant API changes in future releases. +It is versioned according to `SemVer <http://semver.org/>`_. +Although it is pre-v1, patch releases are only published for backwards compatible bug fixes. + +The source code is available under the terms of the `GNU Affero General Public License Version 3 <https://www.gnu.org/licenses/agpl-3.0.html>`_. +It is hosted at `<https://git.cccv.de/uffd/python-ldapserver>`_. +Releases are also available on `PyPI <https://pypi.org/project/ldapserver/>`_. + +API Reference +------------- .. toctree:: :maxdepth: 2 @@ -12,8 +30,3 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` - -.. _RFC 4513: https://tools.ietf.org/html/rfc4513 -.. _RFC 4513 5.1.1.: https://tools.ietf.org/html/rfc4513#section-5.1.1 -.. _RFC 4513 5.1.2.: https://tools.ietf.org/html/rfc4513#section-5.1.2 -.. _RFC 4513 5.1.3.: https://tools.ietf.org/html/rfc4513#section-5.1.3 diff --git a/setup.py b/setup.py index 63910cfe4096eee51c806dc4a1e1f1bcccb3fb32..c8bea5901eb79c281e0d9aa86afa67fe55858cb9 100644 --- a/setup.py +++ b/setup.py @@ -15,7 +15,7 @@ setuptools.setup( url='https://git.cccv.de/uffd/python-ldapserver', classifiers=[ 'Programming Language :: Python :: 3', - 'Development Status :: 2 - Pre-Alpha', + 'Development Status :: 3 - Alpha', 'License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)', 'Operating System :: OS Independent', 'Topic :: System :: Systems Administration :: Authentication/Directory :: LDAP',