Merge pull request #8 from canonical/generate-sitemap

feat: Add generate_sitemap function

Author: britneywwc

canonicalwebteam/directory_parser/__init__.py

@@ -1 +1,4 @@
-from canonicalwebteam.directory_parser.app import scan_directory  # noqa
+from canonicalwebteam.directory_parser.app import (  # noqa
+    scan_directory,  # noqa
+    generate_sitemap,  # noqa
+)

canonicalwebteam/directory_parser/app.py

@@ -1,3 +1,4 @@
+import flask
 import re
 import subprocess
 from contextlib import suppress
@@ -266,6 +267,22 @@ def get_git_last_modified_time(path):
         return None
 
 
+def generate_sitemap(directory_path, base_url):
+    """
+    Generate sitemap given a directory path and a base url. It uses the
+    local project's templates to generate the sitemap.
+
+    TODO: Include sitemap_template.xml in the directory_parser package
+    """
+    tree = scan_directory(directory_path)
+    xml_sitemap = flask.render_template(
+        "/sitemap_template.xml",
+        tree=tree["children"],
+        base_url=base_url,
+    )
+    return xml_sitemap
+
+
 def scan_directory(path_name, base=None):
     """
     We scan a given directory for valid pages and return a tree

setup.py

@@ -4,7 +4,7 @@
 
 setup(
     name="canonicalwebteam.directory-parser",
-    version="1.1.0",
+    version="1.1.1",
     author="Canonical webteam",
     author_email="webteam@canonical.com",
     url="https://github.com/canonical/canonicalwebteam.directory-parser",