Metadata-Version: 2.1
Name: myldapsync
Version: 1.0.4
Summary: Synchronise LDAP users to MySQL and MariaDB
Home-page: https://github.com/6eh01der/myldapsync
Author: Artur Lebedev
Author-email: ras_atari@mail.ru
License: MySQL
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: ldap3>=2.9.1
Requires-Dist: mysql-connector-python>=8.0.31
Requires-Dist: pyasn1>=0.4.8

# myldapsync - fork of [pgldapsync](https://github.com/EnterpriseDB/pgldapsync) by [EnterpriseDB Corporation](https://www.enterprisedb.com/) adopted for MySQL and MariaDB

This Python module allows you to synchronise MySQL or MariaDB users
with users in an LDAP directory.

Require MySQL 8 with installed and configured simple or sasl LDAP Authentication Plugin or PAM plugin (pam also supported in MySQL 5.7 and MariaDB).

Percona Server for MySQL:

https://docs.percona.com/percona-server/8.0/ldap-authentication

https://docs.percona.com/percona-server/8.0/pam-plugin.html

MySQL:

https://dev.mysql.com/doc/refman/8.0/en/ldap-pluggable-authentication.html

https://dev.mysql.com/doc/refman/8.0/en/pam-pluggable-authentication.html

MariaDB:

https://mariadb.com/kb/en/authentication-plugin-pam/

*myldapsync is supported on Python 3.8 or later.*

In order to use it, you will need to create a _config.ini_ 
file containing the site-specific configuration you require. 
See _config.ini.example_ for a complete list of all the 
available configuration options. This file should be copied to
create your own configuration.

Once configured, simply run myldapsync like so:

    python3 myldapsync.py /path/to/config.ini

In order to test the configuration (and dump the SQL that would
be executed to stdout), run it like this:

    python3 myldapsync.py --dry-run /path/to/config.ini

## Creating a virtual environment for dev/test

    python3 -m venv /path/to/myldapsync
    source /path/to/myldapsync/bin/activate
    pip install -r requirements.txt

Adapt the first command as required for your environment/Python
version.

## Creating a package

To create a package (wheel), run the following in your virtual 
environment:

    python3 setup.py sdist bdist_wheel


