Adding sdk

Author: eamonnfaherty

cloudformation_docs/cli.py

@@ -1,76 +1,10 @@
 import click
 import json
-import logging
 from cfn_flip import to_json
 
-from jinja2 import Template
+from . import core
 
-logger = logging.getLogger()
-logger.setLevel(logging.INFO)
 
-
-def get_parameters(template):
-    params = template.get('Parameters')
-    if not params:
-        params = template.get('parameters')
-    if not params:
-        params = []
-    return params
-
-
-def get_resources(template):
-    resources = template.get('Resources')
-    if not resources:
-        resources = template.get('resources')
-    if not resources:
-        resources = []
-    return resources
-
-
-def get_outputs(template):
-    outputs = template.get('Outputs')
-    if not outputs:
-        outputs = template.get('outputs')
-    if not outputs:
-        outputs = []
-    return outputs
-
-
-def get_description(template):
-    description = template.get("Description")
-    if not description:
-        description = template.get('description')
-    if not description:
-        description = "No Template description set"
-    return description
-
-TEMPLATE = """# {{ name }}
-# Description
-{{ description }}
-
-## Parameters
-The list of parameters for this template:
-{% for parameter in parameters %}
-### {{ parameter }} 
-Type: {{ parameters[parameter].Type }} {% if parameters[parameter].Default %}
-Default: {{ parameters[parameter].Default}}{% endif %} {% if parameters[parameter].Description %}
-Description: {{ parameters[parameter].Description}}{% endif %} {% endfor %}
-
-## Resources
-The list of resources this template creates:
-{% for resource in resources %}
-### {{ resource }} 
-Type: {{ resources[resource].Type }} {% if resources[resource].Description %}
-Description: {{ resources[resource].Description}}{% endif %} {% endfor %}
-
-## Outputs
-The list of outputs this template exposes:
-{% for output in outputs %}
-### {{ output }} 
-{% if outputs[output].Description %}Description: {{ outputs[output].Description}}{% endif %}{% if outputs[output].Export %} 
-Export name: {{ outputs[output].Export.Name }}{% endif %}  
-{% endfor %}
-"""
 @click.command()
 @click.argument('f', type=click.File())
 def generate(f):
@@ -82,18 +16,9 @@ def generate(f):
     else:
         raise Exception("{}: not a valid file extension".format(extension))
     template = json.loads(j)
-    description = get_description(template)
-    parameters = get_parameters(template)
-    resources = get_resources(template)
-    outputs = get_outputs(template)
+    result = core.generate(template, ".".join(f.name.split(".")[0:-1]))
+    click.echo(result)
 
-    click.echo(Template(TEMPLATE).render(
-        name=f.name.replace(".{}".format(extension), ''),
-        description=description,
-        parameters=parameters,
-        resources=resources,
-        outputs=outputs,
-    ))
 
 if __name__ == "__main__":
     generate()

cloudformation_docs/core.py

@@ -0,0 +1,81 @@
+from jinja2 import Template
+
+
+def get_parameters(template):
+    params = template.get('Parameters')
+    if not params:
+        params = template.get('parameters')
+    if not params:
+        params = []
+    return params
+
+
+def get_resources(template):
+    resources = template.get('Resources')
+    if not resources:
+        resources = template.get('resources')
+    if not resources:
+        resources = []
+    return resources
+
+
+def get_outputs(template):
+    outputs = template.get('Outputs')
+    if not outputs:
+        outputs = template.get('outputs')
+    if not outputs:
+        outputs = []
+    return outputs
+
+
+def get_description(template):
+    description = template.get("Description")
+    if not description:
+        description = template.get('description')
+    if not description:
+        description = "No Template description set"
+    return description
+
+
+TEMPLATE = """# {{ name }}
+# Description
+{{ description }}
+
+## Parameters
+The list of parameters for this template:
+{% for parameter in parameters %}
+### {{ parameter }} 
+Type: {{ parameters[parameter].Type }} {% if parameters[parameter].Default %}
+Default: {{ parameters[parameter].Default}}{% endif %} {% if parameters[parameter].Description %}
+Description: {{ parameters[parameter].Description}}{% endif %} {% endfor %}
+
+## Resources
+The list of resources this template creates:
+{% for resource in resources %}
+### {{ resource }} 
+Type: {{ resources[resource].Type }} {% if resources[resource].Description %}
+Description: {{ resources[resource].Description}}{% endif %} {% endfor %}
+
+## Outputs
+The list of outputs this template exposes:
+{% for output in outputs %}
+### {{ output }} 
+{% if outputs[output].Description %}Description: {{ outputs[output].Description}}{% endif %}{% if outputs[output].Export %} 
+Export name: {{ outputs[output].Export.Name }}{% endif %}  
+{% endfor %}
+"""
+
+
+def generate(template, name):
+    description = get_description(template)
+    parameters = get_parameters(template)
+    resources = get_resources(template)
+    outputs = get_outputs(template)
+
+    return Template(TEMPLATE).render(
+        name=name,
+        description=description,
+        parameters=parameters,
+        resources=resources,
+        outputs=outputs,
+    )

cloudformation_docs/sdk.py

@@ -0,0 +1,13 @@
+from . import core
+import json
+import yaml
+
+
+def generate_from_json(template_content, name):
+    result = core.generate(json.loads(template_content), name)
+    return result
+
+
+def generate_from_yaml(template_content, name):
+    result = core.generate(yaml.safe_load(template_content), name)
+    return result

setup.py

@@ -8,7 +8,7 @@
 
 setuptools.setup(
     name="cloudformation-docs",
-    version="0.2.0",
+    version="0.3.0",
     author="Eamonn Faherty",
     author_email="packages@designandsolve.co.uk",
     description="Generate docs from cloudformation templates",