Finished up documentation, fix #24

Author: dorianim

docs/index.rst

@@ -31,10 +31,10 @@ Particularly, some `appliances (Proxmox, XCP-ng and KVM) are prepared <https://d
    :hidden:
 
    python/shares.rst
+   python/ldapHelper.rst
+   python/realm.rst
+   python/printers.rst
    python/computer.rst
+   python/user.rst
    python/config.rst
-   python/environment.rst
-   python/fileHelper.rst
-   python/gpo.rst
-   python/hooks.rst
-   python/imageHelper.rst
+   python/otherHelpers.rst

docs/python/environment.rst

@@ -0,0 +1,9 @@
+Module: ldapHelper
+******************
+
+This module is used to deal with all LDAP tasks, like performing searches and checking group memberships.
+
+Members
+=======
+.. automodule:: linuxmusterLinuxclient7.ldapHelper
+   :members:

docs/python/fileHelper.rst

@@ -0,0 +1,102 @@
+Other helper modules
+********************
+
+Module: logging
+===============
+
+This module is used to deal with all logs. It not only prints them but also writes them to `/var/log/syslog`
+
+Members
+-------
+.. automodule:: linuxmusterLinuxclient7.logging
+   :members:
+
+Module: localUserHelper
+=======================
+
+This module is used to deal with local users.
+
+Members
+-------
+.. automodule:: linuxmusterLinuxclient7.localUserHelper
+   :members:
+
+Module: setup
+=================
+
+This module is used to setup, clean and upgrade the client.
+
+Members
+-------
+.. automodule:: linuxmusterLinuxclient7.seup
+   :members:
+
+Module: imageHelper
+===================
+
+This module is used to prepare a client for imaging.
+
+Members
+-------
+.. automodule:: linuxmusterLinuxclient7.imageHelper
+   :members:
+
+Module: hooks
+=============
+
+This module is used to deal with local hookdirs in `/etc/linuxmuster-linuxclient7` and the sysvol.
+
+Members
+-------
+.. automodule:: linuxmusterLinuxclient7.hooks
+   :members:
+
+Module: gpo
+===========
+
+This module is used to deal with Microsoft GPOs.
+
+Members
+-------
+.. automodule:: linuxmusterLinuxclient7.gpo
+   :members:
+
+Module: fileHelper
+==================
+
+This module is used to deal files.
+
+Members
+-------
+.. automodule:: linuxmusterLinuxclient7.fileHelper
+   :members:
+
+Module: environment
+===================
+
+This module is used to export and unset environment variables during the onLogin/logon hook.
+
+Members
+-------
+.. automodule:: linuxmusterLinuxclient7.environment
+   :members:
+
+Module: keytab
+==============
+
+This module is used to manage the keytab (`/etc/krb5.keytab`) file.
+
+Members
+-------
+.. automodule:: linuxmusterLinuxclient7.keytab
+   :members:
+
+Module: templates
+=================
+
+This module is used to manage templates for config files.
+
+Members
+-------
+.. automodule:: linuxmusterLinuxclient7.templates
+   :members:

docs/python/gpo.rst

@@ -0,0 +1,9 @@
+Module: printers
+****************
+
+This module is used to deal with networked printers
+
+Members
+=======
+.. automodule:: linuxmusterLinuxclient7.printers
+   :members:

docs/python/hooks.rst

@@ -0,0 +1,15 @@
+Module: realm
+*************
+
+This module is used to deal with all AD related things:
+
+* Discovering domains
+* Joining domains 
+* Leaving domains
+* Clearing the local user cache
+* Pulling kerberos tickets using the computer account
+
+Members
+=======
+.. automodule:: linuxmusterLinuxclient7.realm
+   :members:

docs/python/imageHelper.rst

@@ -0,0 +1,9 @@
+Module: user
+************
+
+This module is used to deal with users and their properties, like username and groups.
+
+Members
+=======
+.. automodule:: linuxmusterLinuxclient7.user
+   :members:

docs/python/ldapHelper.rst

@@ -2,6 +2,12 @@
 from linuxmusterLinuxclient7 import computer, config, logging
 
 def patchKeytab():
+    """
+    Patches the `/etc/krb5.keytab` file. It inserts the correct hostname of the current computer.
+
+    :return: True on success, False otherwise
+    :rtype: bool
+    """
     krb5KeytabFilePath = "/etc/krb5.keytab"
     logging.info("Patching {}".format(krb5KeytabFilePath))
     krb5KeytabUtil = Krb5KeytabUtil(krb5KeytabFilePath)

docs/python/otherHelpers.rst

@@ -4,6 +4,12 @@
 _currentLdapConnection = None
 
 def serverUrl():
+    """
+    Returns the server URL
+
+    :return: The server URL
+    :rtype: str
+    """
     rc, networkConfig = config.network()
 
     if not rc:
@@ -13,6 +19,12 @@ def serverUrl():
     return 'ldap://{0}'.format(serverHostname)
 
 def baseDn():
+    """
+    Returns the base DN
+
+    :return: The baseDN
+    :rtype: str
+    """
     rc, networkConfig = config.network()
 
     if not rc:
@@ -22,6 +34,12 @@ def baseDn():
     return "dc=" + domain.replace(".", ",dc=")
 
 def conn():
+    """
+    Returns the ldap connection object
+
+    :return: The ldap connection object
+    :rtype: ldap.ldapobject.LDAPObject
+    """
     global _currentLdapConnection
 
     if _connect():
@@ -30,6 +48,13 @@ def conn():
     return None
 
 def searchOne(filter):
+    """Searches the LDAP with a filter and returns the first found object
+
+    :param filter: A valid ldap filter
+    :type filter: str
+    :return: Tuple (success, ldap object as dict)
+    :rtype: tuple
+    """
     if conn() == None:
         logging.error("Cannot talk to LDAP")
         return False, None
@@ -72,6 +97,16 @@ def searchOne(filter):
         return False, None
 
 def isObjectInGroup(objectDn, groupName):
+    """
+    Check if a given object is in a given group
+
+    :param objectDn: The DN of the object
+    :type objectDn: str
+    :param groupName: The name of the group
+    :type groupName: str
+    :return: True if it is a member, False otherwise
+    :rtype: bool
+    """
     logging.debug("= Testing if object {0} is a member of group {1} =".format(objectDn, groupName))
     rc, groupAdObject = searchOne("(&(member:1.2.840.113556.1.4.1941:={0})(sAMAccountName={1}))".format(objectDn, groupName))
     logging.debug("=> Result: {} =".format(rc))

docs/python/printers.rst

@@ -2,6 +2,14 @@
 from linuxmusterLinuxclient7 import logging
 
 def getGroupsOfLocalUser(username):
+    """
+    Get all groups of a local user
+
+    :param username: The username of the user
+    :type username: str
+    :return: Tuple (success, list of groups)
+    :rtype: tuple
+    """
     try:
         groups = subprocess.check_output(["id", "-Gnz", username])
         stringList=[x.decode('utf-8') for x in groups.split(b"\x00")]

docs/python/realm.rst

@@ -10,28 +10,70 @@ class Level(Enum):
     FATAL = 4
 
 def debug(message):
+    """
+    Do a debug log.
+
+    :param message: The message to log
+    :type message: str
+    """
     _log(Level.DEBUG, message)
 
 def info(message):
+    """
+    Do an info log.
+
+    :param message: The message to log
+    :type message: str
+    """
     _log(Level.INFO, message)
 
 def warning(message):
+    """
+    Do a warning log.
+
+    :param message: The message to log
+    :type message: str
+    """
     _log(Level.WARNING, message)
 
 def error(message):
+    """
+    Do an error log.
+
+    :param message: The message to log
+    :type message: str
+    """
     _log(Level.ERROR, message)
 
 def fatal(message):
+    """
+    Do a fatal log. If used in onLogin hook, this will create a dialog containing the message.
+
+    :param message: The message to log
+    :type message: str
+    """
     _log(Level.FATAL, message)
 
 def exception(exception):
+    """
+    Log an exception
+
+    :param exception: The exception to log
+    :type exception: Exception
+    """
     error("=== An exception occurred ===")
     error(str(exception))
     # Only use for debugging! This will cause ugly error dialogs in X11
     #traceback.print_tb(exception.__traceback__)
     error("=== end exception ===")
 
 def printLogs(compact=False):
+    """
+    Print logs of linuxmuster-linuxclient7 from `/var/log/syslog`.
+
+    :param compact: If set to True, some stuff like time and date will be removed. Defaults to False
+    :type compact: bool, optional
+    """
     print("===========================================")
     print("=== Linuxmuster-linuxclient7 logs begin ===")