Metadata-Version: 2.0
Name: gitlab-users
Version: 0.3
Summary: Export GitLab users information and automate user accounts creation
Home-page: https://gitlab.math.unistra.fr/gitlab-tools/gitlab-users
Author: Matthieu Boileau
Author-email: matthieu.boileau@math.unistra.fr
License: MIT
Keywords: gitlab API CLI
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Dist: python-gitlab (>0.20)

gitlab-users
============

A simple command line interface to handle GitLab user accounts, based on
`python-gitlab <https://github.com/python-gitlab/python-gitlab>`__.

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

-  Install the package on your system

::

    pip install gitlab-users

-  Edit the ``~/.python-gitlab.cfg`` following the `python-gitlab
   package
   instructions <http://python-gitlab.readthedocs.io/en/stable/cli.html>`__
   to setup the GitLab instance to connect with (present version only
   targets default instance).

Usage
-----

-  Get help

::

    gitlab-users -h

-  List all users with their email

::

    gitlab-users

-  List emails from a given group

::

    gitlab-users -g a_group --email-only

-  Create multiple user accounts at once from a csv file

::

    gitlab-users --create-from example.csv

where ``example.csv`` contains

::

    # username, name, email, [organization], [location], [group], [access_level]
    wayne,Bruce Wayne,bruce.wayne@wayne-entreprises.com,Wayne Entreprises,Gotham City,Board,owner
    kent,Clark Kent,clark.kent@krypton.univ,,Smallville,,

-  List unused accounts (never sign-in or last connection is older than
   1 year)

::

    gitlab-users --unused


