add doc for module computer

Author: dorianim

docs/index.rst

@@ -17,7 +17,7 @@ Linuxmuster-linuxclient7 is a part of the `linuxmuster.net <https://www.linuxmus
 
 You can find the whole description of the install process on the `official documentation page <https://docs.linuxmuster.net/de/latest/>`_ of the project.
 
-In particularly, some `appliances (Proxmox, XCP-ng and KVM) are prepared <https://docs.linuxmuster.net/de/latest/getting-started/installoptions/index.html>`_ in order to permit a fast deployment for test use.
+Particularly, some `appliances (Proxmox, XCP-ng and KVM) are prepared <https://docs.linuxmuster.net/de/latest/getting-started/installoptions/index.html>`_ in order to permit a fast deployment for test use.
 
 .. toctree::
    :maxdepth: 1
@@ -31,3 +31,4 @@ In particularly, some `appliances (Proxmox, XCP-ng and KVM) are prepared <https:
    :hidden:
 
    python/shares.rst
+   python/computer.rst

docs/python/shares.rst

@@ -1,9 +1,9 @@
 Module: shares
 **************
 
-This is used to deal with mounting and unmounting samba shares.
+This module is used to deal with mounting and unmounting samba shares.
 
-Shares API
-============
+Members
+=======
 .. automodule:: linuxmusterLinuxclient7.shares
    :members:

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/computer.py

@@ -2,22 +2,54 @@
 from linuxmusterLinuxclient7 import logging, ldapHelper, realm, localUserHelper
 
 def hostname():
+    """
+    Get the hostname of the computer
+
+    :return: The hostname
+    :rtype: str
+    """
     return socket.gethostname().split('.', 1)[0]
 
 def krbHostName():
+    """
+    Get the krb hostname, eg. `COMPUTER01$`
+
+    :return: The krb hostname
+    :rtype: str
+    """
     return hostname().upper() + "$"
 
 def readAttributes():
+    """
+    Read all ldap attributes of the cumputer
+
+    :return: Tuple (success, dict of attributes)
+    :rtype: tuple
+    """
     return ldapHelper.searchOne("(sAMAccountName={}$)".format(hostname()))
 
 def isInGroup(groupName):
+    """
+    Check if the computer is part of an ldap group
+
+    :param groupName: The name of the group to check
+    :type grouName: str
+    :return: True or False
+    :rtype: bool
+    """
     rc, groups = localUserHelper.getGroupsOfLocalUser(krbHostName())
     if not rc:
         return False
 
     return groupName in groups
 
 def isInAD():
+    """
+    Check if the computer is joined to an AD
+
+    :return: True or False
+    :rtype: bool
+    """
     rc, groups = localUserHelper.getGroupsOfLocalUser(krbHostName())
     if not rc:
         return False