Update cookbook gallery (#69)

Co-authored-by: jnmorley <[email protected]>

Author: jukent

.github/ISSUE_TEMPLATE/update-cookbook-gallery.yaml

@@ -2,14 +2,14 @@ name: Update Cookbook Gallery
 description: For submitting a new Cookbook repository for acceptance into the gallery
 title: 'Update Gallery with new Cookbook'
 labels: ['content', 'cookbook-gallery-submission']
-assignees: 
+assignees:
   - ProjectPythiaCookbooks/education
 
 body:
   - type: markdown
     attributes:
       value: |
-        Thank you for your contribution to the Project Pythia Cookbook Gallery! 
+        Thank you for your contribution to the Project Pythia Cookbook Gallery!
   - type: input
     id: root-repo-name
     attributes:
@@ -25,10 +25,9 @@ body:
       multiple: true
       options:
         - 'yes'
-        - 'no'       
+        - 'no'
   - type: textarea
     id: comments
     attributes:
       label: Additional comments
       description: Please add any additional comments on this issue here.
-      

.github/workflows/collect-user-submission.py

@@ -24,18 +24,18 @@ def create_submission(self):
         return self
 
     def _create_submission_input(self):
-        text = self.data['issue']['body'] 
+        text = self.data["issue"]["body"]
 
         left = "### Root Repository Name"
         right = "### Did you check"
-        repo = text[text.index(left)+len(left):text.index(right)].strip()
-        
+        repo = text[text.index(left) + len(left) : text.index(right)].strip()
+
         self.submission = Submission(repo=repo)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
 
-    issue = IssueInfo(gh_event_path=os.environ['GITHUB_EVENT_PATH']).create_submission()
+    issue = IssueInfo(gh_event_path=os.environ["GITHUB_EVENT_PATH"]).create_submission()
     input = issue.submission.dict()
-    with open('cookbook-submission-input.txt', 'w') as f:
-        f.write(input['repo'])
+    with open("cookbook-submission-input.txt", "w") as f:
+        f.write(input["repo"])

cookbook-submission-input.txt

@@ -12,4 +12,3 @@ dependencies:
 - sphinx-panels
 - pip:
   - sphinx-pythia-theme
-  

environment.yml

@@ -7,7 +7,7 @@ select = B,C,E,F,W,T4,B9
 
 [isort]
 known_first_party=
-known_third_party=frontmatter,gallery_generator,markdown_it,pydantic,truncatehtml,yaml
+known_third_party=gallery_generator,pydantic,truncatehtml,yaml
 multi_line_output=3
 include_trailing_comma=True
 force_grid_wrap=0

setup.cfg

@@ -3,24 +3,28 @@
 
 def main(app):
 
-    with open('cookbook_gallery.txt') as fid:
+    with open("cookbook_gallery.txt") as fid:
         all_items = fid.readlines()
 
     repo_dicts = generate_repo_dicts(all_items)
 
-    title = 'Cookbooks Gallery'
+    title = "Cookbooks Gallery"
 
-    subtext = ''
-    with open('cookbook_gallery_subtext.md') as fid:
+    subtext = ""
+    with open("cookbook_gallery_subtext.md") as fid:
         for line in fid:
             subtext = subtext + line
 
-    submit_btn_link = 'https://github.com/ProjectPythiaCookbooks/projectpythiacookbooks.github.io/issues/new?assignees=ProjectPythiaCookbooks%2Feducation&labels=content%2Ccookbook-gallery-submission&template=update-cookbook-gallery.yaml&title=Update+Gallery+with+new+Cookbook'
-    submit_btn_txt = 'Submit a new Cookbook'
-    menu_html = generate_menu(repo_dicts, submit_btn_txt=submit_btn_txt, submit_btn_link=submit_btn_link)
-    
-    build_from_repos(repo_dicts, 'index', title=title, subtext=subtext, menu_html=menu_html)
+    submit_btn_link = "https://github.com/ProjectPythiaCookbooks/projectpythiacookbooks.github.io/issues/new?assignees=ProjectPythiaCookbooks%2Feducation&labels=content%2Ccookbook-gallery-submission&template=update-cookbook-gallery.yaml&title=Update+Gallery+with+new+Cookbook"
+    submit_btn_txt = "Submit a new Cookbook"
+    menu_html = generate_menu(
+        repo_dicts, submit_btn_txt=submit_btn_txt, submit_btn_link=submit_btn_link
+    )
+
+    build_from_repos(
+        repo_dicts, "index", title=title, subtext=subtext, menu_html=menu_html
+    )
 
 
 def setup(app):
-    app.connect('builder-inited', main)
+    app.connect("builder-inited", main)

site/_extensions/cookbook_gallery_generator.py

@@ -1,9 +1,9 @@
 import itertools
 import pathlib
-from textwrap import dedent
 import urllib.request
-import yaml
+from textwrap import dedent
 
+import yaml
 from truncatehtml import truncate
 
 
@@ -13,50 +13,54 @@ def _generate_status_badge_html(repo, github_url):
     <a class="reference external" href="https://binder-staging.2i2c.cloud/v2/gh/ProjectPythiaTutorials/{repo}.git/main"><img alt="Binder" src="https://binder-staging.2i2c.cloud/badge_logo.svg" /></a>
     """
 
+
 def generate_repo_dicts(all_items):
 
     repo_dicts = []
     for item in all_items:
         repo = item.strip()
-        github_url = f'https://github.com/ProjectPythiaCookbooks/{repo}'
-        cookbook_url = f'https://cookbooks.projectpythia.org/{repo}/README.html'
-                
-        config_url = f'https://raw.githubusercontent.com/ProjectPythiaCookbooks/{repo}/main/_config.yml'
+        github_url = f"https://github.com/ProjectPythiaCookbooks/{repo}"
+        cookbook_url = f"https://cookbooks.projectpythia.org/{repo}/README.html"
+
+        config_url = f"https://raw.githubusercontent.com/ProjectPythiaCookbooks/{repo}/main/_config.yml"
         config = urllib.request.urlopen(config_url)
         config_dict = yaml.safe_load(config)
 
-        cookbook_title = config_dict['title']
-        authors = config_dict['author']
-        thumbnail = config_dict['thumbnail']
-        description = config_dict['description']
-        tag_dict = {k: v for k, v in config_dict['tags'].items() if v[0] != None}
-
-        repo_dict = {'repo': repo,
-            'github_url': github_url,
-            'cookbook_url': cookbook_url,
-            'cookbook_title': cookbook_title,
-            'authors': authors,
-            'thumbnail': thumbnail,
-            'description': description,
-            'tags': tag_dict
-            }
+        cookbook_title = config_dict["title"]
+        authors = config_dict["author"]
+        thumbnail = config_dict["thumbnail"]
+        description = config_dict["description"]
+        tag_dict = {k: v for k, v in config_dict["tags"].items() if v[0] != None}
+
+        repo_dict = {
+            "repo": repo,
+            "github_url": github_url,
+            "cookbook_url": cookbook_url,
+            "cookbook_title": cookbook_title,
+            "authors": authors,
+            "thumbnail": thumbnail,
+            "description": description,
+            "tags": tag_dict,
+        }
 
         repo_dicts.append(repo_dict)
-        
+
     return repo_dicts
 
 
 def _generate_sorted_tag_keys(repo_dicts):
 
-    key_set = set(itertools.chain(*[repo_dict['tags'].keys() for repo_dict in repo_dicts]))
+    key_set = set(
+        itertools.chain(*[repo_dict["tags"].keys() for repo_dict in repo_dicts])
+    )
     return sorted(key_set)
 
 
 def _generate_tag_set(repo_dicts, tag_key=None):
 
     tag_set = set()
     for repo_dict in repo_dicts:
-        for k, e in repo_dict['tags'].items():
+        for k, e in repo_dict["tags"].items():
             if tag_key and k != tag_key:
                 continue
             for t in e:
@@ -70,7 +74,7 @@ def _generate_tag_menu(repo_dicts, tag_key):
     tag_set = _generate_tag_set(repo_dicts, tag_key)
     tag_list = sorted(tag_set)
 
-    options = ''.join(
+    options = "".join(
         f'<li><label class="dropdown-item checkbox {tag_key}"><input type="checkbox" rel={tag.replace(" ", "-")} onchange="change();">&nbsp;{tag}</label></li>'
         for tag in tag_list
     )
@@ -96,43 +100,54 @@ def generate_menu(repo_dicts, submit_btn_txt=None, submit_btn_link=None):
     menu_html += '<div class="d-flex gallery-menu">\n'
     if submit_btn_txt:
         menu_html += f'<div><a role="button" class="btn btn-primary btn-sm mx-1" href={submit_btn_link}>{submit_btn_txt}</a></div>\n'
-    menu_html += '</div>\n'
+    menu_html += "</div>\n"
     menu_html += '<div class="ml-auto d-flex">\n'
     menu_html += '<div><button class="btn btn-link btn-sm mx-1" onclick="clearCbs()">Clear all filters</button></div>\n'
     for tag_key in key_list:
-        menu_html += _generate_tag_menu(repo_dicts, tag_key) + '\n'
-    menu_html += '</div>\n'
-    menu_html += '</div>\n'
+        menu_html += _generate_tag_menu(repo_dicts, tag_key) + "\n"
+    menu_html += "</div>\n"
+    menu_html += "</div>\n"
     menu_html += '<script>$(document).on("click",function(){$(".collapse").collapse("hide");}); </script>\n'
     return menu_html
 
 
-def build_from_repos(repo_dicts, filename, title='Gallery', subtitle=None, subtext=None, menu_html='', max_descr_len=300):
+def build_from_repos(
+    repo_dicts,
+    filename,
+    title="Gallery",
+    subtitle=None,
+    subtext=None,
+    menu_html="",
+    max_descr_len=300,
+):
 
     # Build the gallery file
     panels_body = []
     for repo_dict in repo_dicts:
-        repo = repo_dict['repo']
-        github_url = repo_dict['github_url']
+        repo = repo_dict["repo"]
+        github_url = repo_dict["github_url"]
         status_badges = _generate_status_badge_html(repo, github_url)
 
-        cookbook_url = repo_dict['cookbook_url']
-        cookbook_title = repo_dict['cookbook_title']
+        cookbook_url = repo_dict["cookbook_url"]
+        cookbook_title = repo_dict["cookbook_title"]
 
-        authors = repo_dict['authors']
+        authors = repo_dict["authors"]
         authors_str = f"<strong>Author:</strong> {authors}"
 
-        thumbnail = repo_dict['thumbnail']
-        thumbnail_url = f'https://raw.githubusercontent.com/ProjectPythiaCookbooks/{repo}/main/{thumbnail}'
-                
-        tag_dict = repo_dict['tags']
-        tag_list = sorted((itertools.chain(*tag_dict.values())))
-        tag_list_f = [tag.replace(' ', '-') for tag in tag_list]
-        tags = [f'<span class="badge bg-primary mybadges">{tag}</span>' for tag in tag_list_f]
-        tags = '\n'.join(tags)
-        tag_class_str = ' '.join(tag_list_f)
+        thumbnail = repo_dict["thumbnail"]
+        thumbnail_url = f"https://raw.githubusercontent.com/ProjectPythiaCookbooks/{repo}/main/{thumbnail}"
 
-        description = repo_dict['description']
+        tag_dict = repo_dict["tags"]
+        tag_list = sorted((itertools.chain(*tag_dict.values())))
+        tag_list_f = [tag.replace(" ", "-") for tag in tag_list]
+        tags = [
+            f'<span class="badge bg-primary mybadges">{tag}</span>'
+            for tag in tag_list_f
+        ]
+        tags = "\n".join(tags)
+        tag_class_str = " ".join(tag_list_f)
+
+        description = repo_dict["description"]
         ellipsis_str = '<a class="modal-btn"> ... more</a>'
         short_description = truncate(description, max_descr_len, ellipsis=ellipsis_str)
 
@@ -150,7 +165,7 @@ def build_from_repos(repo_dicts, filename, title='Gallery', subtitle=None, subte
 </div>
 """
         else:
-            modal_str = ''
+            modal_str = ""
 
         panels_body.append(
             f"""\
@@ -177,10 +192,10 @@ def build_from_repos(repo_dicts, filename, title='Gallery', subtitle=None, subte
 """
         )
 
-    panels_body = '\n'.join(panels_body)
+    panels_body = "\n".join(panels_body)
 
-    stitle = f'#### {subtitle}' if subtitle else ''
-    stext = subtext if subtext else ''
+    stitle = f"#### {subtitle}" if subtitle else ""
+    stext = subtext if subtext else ""
 
     panels = f"""
 # {title}
@@ -204,4 +219,4 @@ def build_from_repos(repo_dicts, filename, title='Gallery', subtitle=None, subte
 <script src="/_static/custom.js"></script>
 """
 
-    pathlib.Path(f'{filename}.md').write_text(panels)
+    pathlib.Path(f"{filename}.md").write_text(panels)