Metadata-Version: 2.0
Name: PAMMySQLTools
Version: 0.2.1
Summary: A set of tools to manage users from pam_mysql
Home-page: https://github.com/cperrin88/PAMMySQLTools
Author: Christopher Perrin
Author-email: perrin@uni-trier.de
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Console
Requires-Dist: click
Requires-Dist: configparser (>=3.5.0b2)
Requires-Dist: future
Requires-Dist: pymysql
Requires-Dist: six

PAMMySQL Tools
==============

`|build| <https://travis-ci.org/cperrin88/PAMMySQLTools>`_
`|coverage| <https://coveralls.io/github/cperrin88/PAMMySQLTools?branch=master>`_

PAMMySQL Tools ist a suite to manage users for pam\_mysql and
libnss-mysql. It tries to mimic the behaviours of the linux tools
user{add,mod,del} and group{add,mod,del}

Installation
------------

To install simply run:

::

    pip install PAMMySQLTools

This will install the scripts:

-  myuseradd
-  myusermod
-  myuserdel
-  mygroupadd
-  mygroupmod
-  mygroupdel

Configuration
-------------

In the directory ``docs`` you can find an example config with all
everything set. If you don't set a value, the tools will assume the
values in the original config as default values.

Running the Software
--------------------

To display help for any of the scripts, start with the --help parameter

For example:

::

    $ myuseradd --help
    Usage: myuseradd [OPTIONS] LOGIN

    Options:
      -b, --basedir BASE_DIR          base directory for the home directory of the
                                      new account
      -c, --comment COMMENT           GECOS field of the new account
      -d, --home-dir HOME_DIR         home directory of the new account
      -e, --expiredate EXPIRE_DATE    expiration date of the new account
      -f, --inactive INACTIVE         password inactivity period of the new
                                      account
      -g, --gid GROUP                 name or ID of the primary group of the new
                                      account
      -G, --groups GROUPS             list of supplementary groups of the new
                                      account
      -k, --skel SKEL_DIR             use this alternative skeleton directory
      -K, --key KEY=VALUE             override /etc/login.defs defaults
      -M, --no-create-home / -m, --create-home
                                      do not create the user's home directory
      -U, --no-user-group / -N, --user-group
                                      do not create a group with the same name as
                                      the user
      -o, --non-unique                allow to create users with duplicate (non-
                                      unique) UID
      -p, --password PASSWORD         encrypted password of the new account
      -r, --system                    create a system account
      -s, --shell SHELL               login shell of the new account
      -u, --uid UID                   user ID of the new account
      --config CONF_PATH              path to the config file for this tool
      --help                          Show this message and exit.

.. |build| image:: https://travis-ci.org/cperrin88/PAMMySQLTools.svg?branch=master
.. |coverage| image:: https://coveralls.io/repos/github/cperrin88/PAMMySQLTools/badge.svg?branch=master


