Add: partner support to metadata parsing

Author: lwasser

CHANGELOG.md

@@ -6,6 +6,7 @@
 
 * Enh: Use `hatch_vcs` for dynamic versioning (@lwasser, #82)
 * Fix: migrate to pytest for tests and setup hatch scripts (#89, @lwasser)
+* Add: Partner support to package (#92, @lwasser)
 
 ## [v0.15](https://github.com/pyOpenSci/pyosMeta/releases/tag/v0.15)
 

src/pyosmeta/cli/process_reviews.py

@@ -1,12 +1,13 @@
 """
-Script that parses metadata from na issue and adds it to a yml file for the
+Script that parses metadata from and issue and adds it to a .yml file for the
 website. It also grabs some of the package metadata such as stars,
 last commit, etc.
 
-Output: packages.yml file containing a list of
+Output: packages.yml file containing a list of:
  1. all packages with accepted reviews
  2. information related to the review including reviewers, editors
  3. basic package stats including stars, etc.
+ 4. partner information
 
 To run at the CLI: parse_issue_metadata
 """
@@ -23,8 +24,6 @@
 
 from pyosmeta import ProcessIssues, ReviewModel
 
-# TODO: change the template to ask for date accepted format year-month-day
-
 
 def main():
     process_review = ProcessIssues(
@@ -35,6 +34,10 @@ def main():
 
     # Get all issues for approved packages - load as dict
     issues = process_review.return_response()
+    # TODO: this method parse_issue_header is working but the parsing code is
+    # really hard to follow
+    # It is worth another pr that cleans up the workflow around grabbing
+    # metadata so it's clearer to follow.
     accepted_reviews = process_review.parse_issue_header(issues, 45)
 
     # Update gh metrics via api for all packages
@@ -44,6 +47,7 @@ def main():
     )
 
     # Populate model objects with review data + metrics
+    # TODO: all_reviews contains a bunch of extra mess that it doesn't need
     final_reviews = {}
     for key, review in all_reviews.items():
         # First add gh meta to each dict

src/pyosmeta/parse_issues.py

@@ -167,6 +167,7 @@ class ReviewModel(BaseModel):
     closed_at: Optional[str] = None
     issue_link: str = None
     joss: Optional[str] = None
+    partners: Optional[list[str]] = None
     gh_meta: Optional[GhMeta] = None
 
     @field_validator(
@@ -458,26 +459,6 @@ def parse_issue_header(
                 and not key.startswith("-_[x]_i_agree")
             }
             review[pkg_name] = review_clean
-            # filtered = {}
-            # for key, value in review.items():
-            #     print(key)
-            #     if not key.startswith("##") and not key.startswith("-"):
-            #         filtered[key] = value
-
-            # # Clean markdown url's from editor, and reviewer lines
-            # TODO - this could be a reviewer name cleanup validaotr
-            # types = ["editor", "reviewer_1", "reviewer_2"]
-            # user_values = ["github_username", "name"]
-            # for a_type in types:
-            #     for user_value in user_values:
-            #         issue_meta[a_type][user_value] = (
-            #             issue_meta[a_type][user_value]
-            #             .replace("https://github.com/", "")
-            #             .replace("[", "")
-            #             .replace("]", "")
-            #         )
-
-            # review[pkg_name] = issue_meta
 
         return review