add docs to modules

ca_manager.py

@@ -13,6 +13,10 @@ import tempfile
 from certificate_requests import *
 from paths import *
 
+__doc__= """
+Define class to interact with certificate requests and Certification Authority
+"""
+
 class CAManager(object):
     """
     Middleware to interact with ssh-keygen

ca_shell.py

@@ -6,6 +6,10 @@ import sys
 
 from ca_manager import list_cas, sign_request
 
+__doc__= """
+        Class to make a shell and interact with the user
+        """
+
 class CAManagerShell(cmd.Cmd, object):
     intro= """# LILiK CA Manager\n
     Welcome to the certification authority shell.

certificate_requests.py

@@ -8,6 +8,10 @@ import subprocess
 
 from paths import *
 
+__doc__= """
+Module of classes to handle certificate requests
+"""
+
 class SignRequest(object):
     def __init__(self, req_id):
         self.req_id = req_id

paths.py

@@ -6,6 +6,10 @@ REQUESTS_PATH = "/var/lib/ca_manager/requests"
 OUTPUT_PATH = "/var/lib/ca_manager/outputs"
 RESULTS_PATH = "/var/lib/ca_manager/results"
 
+__doc__ = """
+Paths for directories used by the CA manager
+"""
+
 all = [
         MANAGER_PATH,
         RESULTS_PATH,

request_server.py

@@ -7,7 +7,12 @@ import sys
 import time
 import uuid
 
+__doc__= """
+Procedure to spawn a shell for automation, used by Ansible
+"""
+
 logfile= '/home/request/request_server.log'
+
 logging.basicConfig(
         filename= logfile,
         format= '%(asctime)s - %(name)s - %(levelname)s - %(message)s',