docs: small improvements

ziggurat_foundations/models/__init__.py

@@ -5,6 +5,13 @@
 
 
 def groupfinder(userid, request):
+    """
+    Default groupfinder implementaion for pyramid applications
+
+    :param userid:
+    :param request:
+    :return:
+    """
     if userid and hasattr(request, 'user') and request.user:
         groups = ['group:%s' % g.id for g in request.user.groups]
         return groups

ziggurat_foundations/models/external_identity.py

@@ -12,6 +12,11 @@
 
 
 class ExternalIdentityMixin(BaseModel):
+    """
+    Mixin for External Identity model - it represents oAuth(or other) accounts
+    attached to your user object
+    """
+
     __table_args__ = (
         sa.PrimaryKeyConstraint('external_id', 'local_user_id', 'provider_name',
                                 name='pk_external_identities'),

ziggurat_foundations/models/group.py

@@ -11,7 +11,7 @@
 
 
 class GroupMixin(BaseModel):
-    """ base mixin for group object"""
+    """ Mixin for Group model """
 
     _ziggurat_services = [GroupService]
 

ziggurat_foundations/models/group_permission.py

@@ -13,7 +13,7 @@
 
 
 class GroupPermissionMixin(BaseModel):
-    """ group permission mixin """
+    """ Mixin for GroupPermission model"""
 
     __table_args__ = (sa.PrimaryKeyConstraint('group_id', 'perm_name',
                                               name='pk_groups_permissions'),

ziggurat_foundations/models/group_resource_permission.py

@@ -8,6 +8,10 @@
 
 
 class GroupResourcePermissionMixin(BaseModel):
+    """
+    Mixin for GroupResourcePermission model
+    """
+
     __table_args__ = {'mysql_engine': 'InnoDB', 'mysql_charset': 'utf8'}
 
     @declared_attr

ziggurat_foundations/models/resource.py

@@ -14,6 +14,10 @@
 
 
 class ResourceMixin(BaseModel):
+    """
+    Mixin for Resource model
+    """
+
     __possible_permissions__ = ()
 
     _ziggurat_services = [ResourceService, ResourceTreeService]

ziggurat_foundations/models/user.py

@@ -14,7 +14,7 @@
 
 
 class UserMixin(BaseModel):
-    """ Base mixin for user object representation.
+    """ Base mixin for User object representation.
         It supplies all the basic functionality from password hash generation
         and matching to utility methods used for querying database for users
         and their permissions or resources they have access to. It is meant

ziggurat_foundations/models/user_group.py

@@ -7,6 +7,9 @@
 
 
 class UserGroupMixin(BaseModel):
+    """
+    Mixin for UserGroup model
+    """
     __table_args__ = {'mysql_engine': 'InnoDB', 'mysql_charset': 'utf8'}
 
     @declared_attr

ziggurat_foundations/models/user_permission.py

@@ -13,6 +13,9 @@
 
 
 class UserPermissionMixin(BaseModel):
+    """
+    Mixin for UserPermission model
+    """
     __table_args__ = (sa.PrimaryKeyConstraint('user_id', 'perm_name',
                                               name='pk_users_permissions'),
                       {'mysql_engine': 'InnoDB', 'mysql_charset': 'utf8'})

ziggurat_foundations/models/user_resource_permission.py

@@ -13,6 +13,9 @@
 
 
 class UserResourcePermissionMixin(BaseModel):
+    """
+    Mixin for UserResourcePermission model
+    """
     __table_args__ = (sa.PrimaryKeyConstraint(
         'user_id', 'resource_id', 'perm_name',
         name='pk_users_resources_permissions '),