Add docstrings for cdrouter module.

cdrouter/cdrouter.py

@@ -24,6 +24,8 @@
 from .users import UsersService
 
 class Auth(requests.auth.AuthBase): # pylint: disable=too-few-public-methods
+    """Class for authorizing CDRouter Web API requests."""
+
     def __init__(self, token):
         self.token = token
 
@@ -32,6 +34,7 @@ def __call__(self, r):
         return r
 
 class Service(object):
+    """Service for accessing the CDRouter Web API."""
     BASE = '/api/v1'
 
     def __init__(self, base, token, insecure=False):
@@ -56,55 +59,70 @@ def _req(self, path, method='GET', json=None, data=None, params=None, headers=No
                                 json=json, data=data, verify=(not self.insecure), auth=Auth(self.token))
 
     def get(self, path, params=None):
+        """Send an authorized GET request."""
         return self._req(path, method='GET', params=params)
 
     def post(self, path, json=None, data=None, params=None, files=None):
+        """Send an authorized POST request."""
         return self._req(path, method='POST', json=json, data=data, params=params, files=files)
 
     def patch(self, path, json):
+        """Send an authorized PATCH request."""
         return self._req(path, method='PATCH', json=json)
 
     def delete(self, path, params=None):
+        """Send an authorized DELETE request."""
         return self._req(path, method='DELETE', params=params)
 
     # cdrouter-specific request methods
     def list(self, base, filter=None, sort=None, limit=None, page=None, format=None): # pylint: disable=redefined-builtin
+        """Send an authorized GET request for a collection."""
         return self.get(base, params={'filter': filter, 'sort': sort, 'limit': limit,
                                       'page': page, 'format': format})
 
     def get_id(self, base, id, params=None): # pylint: disable=invalid-name,redefined-builtin
+        """Send an authorized GET request to get a resource by ID."""
         return self.get(base+str(id)+'/', params=params)
 
     def create(self, base, resource):
+        """Send an authorized POST request to create a new resource."""
         return self.post(base, json=resource)
 
     def edit(self, base, id, resource): # pylint: disable=invalid-name,redefined-builtin
+        """Send an authorized PATCH request to edit a resource."""
         return self.patch(base+str(id)+'/', json=resource)
 
     def delete_id(self, base, id): # pylint: disable=invalid-name,redefined-builtin
+        """Send an authorized DELETE request to delete a resource by ID."""
         return self.delete(base+str(id)+'/')
 
     def get_shares(self, base, id): # pylint: disable=invalid-name,redefined-builtin
+        """Send an authorized GET request to get a resource's shares."""
         return self.get(base+str(id)+'/shares/')
 
     def edit_shares(self, base, id, user_ids): # pylint: disable=invalid-name,redefined-builtin
+        """Send an authorized PATCH request to edit a resource's shares."""
         return self.patch(base+str(id)+'/shares/', json={'user_ids': map(int, user_ids)})
 
     def export(self, base, id, format='gz', params=None): # pylint: disable=invalid-name,redefined-builtin
+        """Send an authorized GET request to export a resource."""
         params.update({'format': format})
         return self.get(base+str(id)+'/', params=params)
 
     def bulk_export(self, base, ids, params=None):
+        """Send an authorized GET request to bulk export a set of resources."""
         if params is None:
             params = {}
         params.update({'bulk': 'export', 'ids': map(str, ids)})
         return self.get(base, params=params)
 
     def bulk_copy(self, base, resource, ids):
+        """Send an authorized POST request to bulk copy a set of resources."""
         return self.post(base, params={'bulk': 'copy'},
                          json={resource: [{'id': str(x)} for x in ids]})
 
     def bulk_edit(self, base, resource, fields, ids=None, filter=None, all=False, testvars=None): # pylint: disable=redefined-builtin
+        """Send an authorized POST request to bulk edit a set of resources."""
         json = {'fields': fields}
         if ids != None or testvars != None:
             if ids != None:
@@ -115,6 +133,7 @@ def bulk_edit(self, base, resource, fields, ids=None, filter=None, all=False, te
         return self.post(base, params={'bulk': 'edit', 'filter': filter, 'all': all}, json=json)
 
     def bulk_delete(self, base, resource, ids=None, filter=None, all=False): # pylint: disable=redefined-builtin
+        """Send an authorized POST request to bulk delete a set of resources."""
         json = None
         if ids != None:
             json = {resource: [{'id': str(x)} for x in ids]}