Fix docs and cleanups

Author: ethantkoenig

.gitignore

@@ -91,5 +91,3 @@ ENV/
 # IDE files
 .idea/
 
-# DRONE file
-.drone.yml

docs/entities.rst

@@ -1,8 +1,8 @@
 Gogs Entities
 =============
 
-This pages documents classes provided by ``gogs_client`` module that represent entities
-(e.g. users and repositories) in a `Gogs <https://gogs.io/>`_ server.
+This page documents the classes provided by ``gogs_client`` module that represent entities
+(e.g. users, repositories) in a `Gogs <https://gogs.io/>`_ server.
 
 .. py:currentmodule:: gogs_client.entities
 
@@ -21,8 +21,11 @@ This pages documents classes provided by ``gogs_client`` module that represent e
 .. autoclass:: gogs_client.entities::GogsRepo.Hook()
     :members:
 
+.. autoclass:: gogs_client.entities::GogsRepo.DeployKey()
+    :members:
+
 .. autoclass:: gogs_client.entities::GogsOrg()
     :members:
 
-.. autoclass:: gogs_client.entities::GogsOrg.Team()
-    :members:
+.. autoclass:: gogs_client.entities::GogsTeam()
+    :members:

gogs_client/__init__.py

@@ -1,4 +1,4 @@
 from gogs_client.auth import Authentication, Token, UsernamePassword
-from gogs_client.entities import GogsUser, GogsRepo, GogsOrg
+from gogs_client.entities import GogsUser, GogsRepo, GogsOrg, GogsTeam
 from gogs_client.interface import GogsApi, ApiFailure, NetworkFailure
 from gogs_client.updates import GogsUserUpdate, GogsHookUpdate

gogs_client/auth.py

@@ -9,6 +9,7 @@ class Authentication(object):
     An "abstract" parent class. Represents a
     means of authenticating oneself to Gogs
     """
+
     def update_kwargs(self, kwargs):
         """
         Updates kwargs to include this object's authentication information
@@ -23,6 +24,7 @@ class Token(Authentication):
     """
     An immutable representation of a Gogs authentication token
     """
+
     def __init__(self, token, name=None):
         """
         :param str token: contents of Gogs authentication token

gogs_client/entities.py

@@ -15,8 +15,9 @@ def json_get(parsed_json, key):
 
 class GogsUser(object):
     """
-     An immutable representation of a Gogs user.
+     An immutable representation of a Gogs user
     """
+
     def __init__(self, user_id, username, full_name, email, avatar_url):
         self._id = user_id
         self._username = username
@@ -110,7 +111,7 @@ def from_json(parsed_json):
     @property  # named repo_id to avoid conflict with built-in id
     def repo_id(self):
         """
-        The repository's id number
+        The repository's id
 
         :rtype: int
         """
@@ -180,6 +181,7 @@ def __init__(self, html_url, clone_url, ssh_url):
         def html_url(self):
             """
             URL for the repository's webpage
+
             :rtype: str
             """
             return self._html_url
@@ -197,7 +199,8 @@ def clone_url(self):
         def ssh_url(self):
             """
             URL for cloning the repository via SSH
-            :rtype:
+
+            :rtype: str
             """
             return self._ssh_url
 
@@ -256,19 +259,8 @@ def from_json(parsed_json):
             events = json_get(parsed_json, "events")
             active = json_get(parsed_json, "active")
             config = json_get(parsed_json, "config")
-
-            return GogsRepo.Hook(hook_id=hook_id, hook_type=hook_type, events=events, active=active, 
-                            config=config)
-
-        def as_dict(self):
-            fields = {
-                "id": self._id,
-                "type": self._type,
-                "events": self._events,
-                "config": self._config,
-                "active": self._active,
-            }
-            return {k: v for (k, v) in fields.items() if v is not None}
+            return GogsRepo.Hook(hook_id=hook_id, hook_type=hook_type, events=events, active=active,
+                                 config=config)
 
         @property  # named hook_id to avoid conflict with built-in id
         def hook_id(self):
@@ -309,10 +301,7 @@ def active(self):
         @property
         def config(self):
             """
-            Config of the hook. Contains max. 3 keys:
-                - content_type
-                - url
-                - secret
+            Config of the hook. Possible keys include ``"content_type"``, ``"url"``, ``"secret"``
 
             :rtype: dict
             """
@@ -336,19 +325,8 @@ def from_json(parsed_json):
             created_at = json_get(parsed_json, "created_at")
             read_only = json_get(parsed_json, "read_only")
 
-            return GogsRepo.DeployKey(key_id=key_id, key=key, url=url, 
-                            title=title, created_at=created_at, read_only=read_only)
-
-        def as_dict(self):
-            fields = {
-                "id": self._id,
-                "key": self._key,
-                "url": self._url,
-                "title": self._title,
-                "created_at": self._created_at,
-                "read_only": self._read_only,
-            }
-            return {k: v for (k, v) in fields.items() if v is not None}
+            return GogsRepo.DeployKey(key_id=key_id, key=key, url=url,
+                                      title=title, created_at=created_at, read_only=read_only)
 
         @property  # named key_id to avoid conflict with built-in id
         def key_id(self):
@@ -371,7 +349,7 @@ def key(self):
         @property
         def url(self):
             """
-            Url where the key can be found
+            URL where the key can be found
 
             :rtype: str
             """
@@ -389,23 +367,27 @@ def title(self):
         @property
         def created_at(self):
             """
-            Creation date of the key.
+            Creation date of the key
+
             :rtype: str
             """
             return self._created_at
 
         @property
         def read_only(self):
             """
-            Whether key is read-only.
+            Whether key is read-only
+
             :rtype: bool
             """
             return self._read_only
 
+
 class GogsOrg(object):
     """
-     An immutable representation of a Gogs Organization.
+     An immutable representation of a Gogs Organization
     """
+
     def __init__(self, org_id, username, full_name, avatar_url, description, website, location):
         self._id = org_id
         self._username = username
@@ -425,20 +407,8 @@ def from_json(parsed_json):
         website = json_get(parsed_json, "website")
         location = json_get(parsed_json, "location")
         return GogsOrg(org_id=org_id, username=username, full_name=full_name,
-                        avatar_url=avatar_url, description=description,
-                        website=website, location=location)
-
-    def as_dict(self):
-        fields = {
-            "id": self._id,
-            "username": self._username,
-            "full_name": self._full_name,
-            "avatar_url": self._avatar_url,
-            "description": self._description,
-            "website": self._website,
-            "location": self._location
-        }
-        return {k: v for (k, v) in fields.items() if v is not None}
+                       avatar_url=avatar_url, description=description,
+                       website=website, location=location)
 
     @property  # named org_id to avoid conflict with built-in id
     def org_id(self):
@@ -449,7 +419,7 @@ def org_id(self):
         """
         return self._id
 
-    @property  
+    @property
     def username(self):
         """
         Organization's username
@@ -458,111 +428,102 @@ def username(self):
         """
         return self._username
 
-    @property  
+    @property
     def full_name(self):
         """
         Organization's full name
 
         :rtype: str
         """
-        return self._full_name 
+        return self._full_name
 
-    @property  
+    @property
     def avatar_url(self):
         """
         Organization's avatar url
 
         :rtype: str
         """
-        return self._avatar_url 
+        return self._avatar_url
 
-    @property  
+    @property
     def description(self):
         """
         Organization's description
 
         :rtype: str
         """
-        return self._description 
+        return self._description
 
-    @property  
+    @property
     def website(self):
         """
         Organization's website address
 
         :rtype: str
         """
-        return self._website 
+        return self._website
 
-    @property  
+    @property
     def location(self):
         """
         Organization's location
 
         :rtype: str
         """
-        return self._location 
+        return self._location
 
-    class Team(object):
-        """
-        Team of an organization
-        """
-        def __init__(self, team_id, name, description, permission):
-            self._id = team_id
-            self._name = name
-            self._description = description
-            self._permission = permission
 
-        @staticmethod
-        def from_json(parsed_json):
-            team_id = json_get(parsed_json, "id")
-            name = json_get(parsed_json, "name")
-            description = json_get(parsed_json, "description")
-            permission = json_get(parsed_json, "permission")
-            return GogsOrg.Team(team_id=team_id, name=name, description=description, permission=permission)
-
-        def as_dict(self):
-            fields = {
-                "team_id": self._id,
-                "name": self._name,
-                "description": self._description,
-                "permission": self._permission,
-            }
-            return {k: v for (k, v) in fields.items() if v is not None}
-
-        @property  # named team_id to avoid conflict with built-in id
-        def team_id(self):
-            """
-            Team's id
+class GogsTeam(object):
+    """
+    An immutable representation of a Gogs organization team
+    """
+    def __init__(self, team_id, name, description, permission):
+        self._id = team_id
+        self._name = name
+        self._description = description
+        self._permission = permission
 
-            :rtype: int
-            """
-            return self._id 
+    @staticmethod
+    def from_json(parsed_json):
+        team_id = json_get(parsed_json, "id")
+        name = json_get(parsed_json, "name")
+        description = json_get(parsed_json, "description")
+        permission = json_get(parsed_json, "permission")
+        return GogsTeam(team_id=team_id, name=name, description=description, permission=permission)
 
-        @property
-        def name(self):
-            """
-            Team name
+    @property  # named team_id to avoid conflict with built-in id
+    def team_id(self):
+        """
+        Team's id
 
-            :rtype: str
-            """
-            return self._name
+        :rtype: int
+        """
+        return self._id
 
-        @property
-        def description(self):
-            """
-            Description to the team
+    @property
+    def name(self):
+        """
+        Team name
 
-            :rtype: str
-            """
-            return self._description
+        :rtype: str
+        """
+        return self._name
 
-        @property
-        def permission(self):
-            """
-            Team permission, can be read, write or admin, default is read
+    @property
+    def description(self):
+        """
+        Description of the team
 
-            :rtype: int
-            """
-            return self._permission
+        :rtype: str
+        """
+        return self._description
 
+    @property
+    def permission(self):
+        """
+        Team permission, can be read, write or admin, default is read
+
+        :rtype: int
+        """
+        return self._permission