math-spec-mapping 0.3.16__tar.gz → 0.3.17__tar.gz

{math_spec_mapping-0.3.16/src/math_spec_mapping.egg-info → math_spec_mapping-0.3.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: math-spec-mapping
-Version: 0.3.16
+Version: 0.3.17
 Summary: A library for easy mapping of mathematical specifications.
 Author-email: Sean McOwen <Sean@Block.Science>
 Classifier: Programming Language :: Python :: 3

{math_spec_mapping-0.3.16 → math_spec_mapping-0.3.17}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
 [project]
 name = "math-spec-mapping"
-version = "0.3.16"
+version = "0.3.17"
 authors = [
   { name="Sean McOwen", email="Sean@Block.Science" },
 ]

math_spec_mapping-0.3.17/src/math_spec_mapping/Convenience/__init__.py

@@ -0,0 +1,8 @@
+# from .documentation import write_top_level_json_description
+from .starter import remove_dummy_repo_components
+from .github import (
+    write_scaffold_to_github_issues,
+    find_open_issues,
+    create_priority_label_matrix,
+    create_milestone_label_matrix,
+)

math_spec_mapping-0.3.17/src/math_spec_mapping/Convenience/github.py

@@ -0,0 +1,108 @@
+import os
+import requests
+from github import Github, Auth
+import pandas as pd
+from dotenv import load_dotenv
+
+
+def write_scaffold_to_github_issues(
+    scaffolder_folder, repo_owner, repository_name, access_token
+):
+    folders = [
+        x
+        for x in os.listdir(scaffolder_folder)
+        if os.path.isdir(scaffolder_folder + "/" + x)
+    ]
+    headers = {
+        "Accept": "application/vnd.github+json",
+        "X-GitHub-Api-Version": "2022-11-28",
+        "Authorization": "Bearer {}".format(access_token),
+    }
+    for folder in folders:
+        issue_name = "Write {} from MSML Scaffold".format(folder)
+        checklist = [
+            x[:-3]
+            for x in os.listdir(scaffolder_folder + "/" + folder)
+            if x.endswith(".md")
+        ]
+        checklist = ["- [ ] " + x for x in checklist]
+        checklist = "\n".join(checklist)
+
+        requests.post(
+            "https://api.github.com/repos/{}/{}/issues".format(
+                repo_owner, repository_name
+            ),
+            headers=headers,
+            json={"title": issue_name, "body": checklist},
+        )
+
+
+def find_open_issues():
+    load_dotenv()
+    g = Github(auth=Auth.Token(os.getenv("GITHUB_TOKEN")))
+    repo = g.get_repo("BlockScience/MSML")
+    open_issues = repo.get_issues(state="open")
+    open_issues = list(open_issues)
+
+    df = pd.DataFrame(
+        [[x.title, x.labels, x.html_url, x.milestone] for x in open_issues],
+        columns=["Name", "Labels", "URL", "Milestone"],
+    )
+    df["Milestone"] = df["Milestone"].apply(lambda x: x.title if x else None)
+    df = df.join(
+        df["Labels"]
+        .apply(lambda x: {y.name: True for y in x})
+        .apply(pd.Series)
+        .fillna(False)
+    )
+
+    empty = df[df["Labels"].apply(lambda x: len(x)) == 0]
+    empty = empty[~empty["URL"].str.contains("MSML/pull")]
+    assert len(empty) == 0, "Some issues do not have labels"
+
+    return df, open_issues
+
+
+def create_priority_label_matrix(df, exclude_milestones=None):
+    if exclude_milestones:
+        df = df[~df["Milestone"].isin(exclude_milestones)]
+    priority_labels = ["High Priority", "Medium Priority", "Low Priority"]
+    labels = list(df.columns[4:])
+    labels = sorted([x for x in labels if x not in priority_labels])
+
+    table = []
+    for label in labels:
+        row = []
+        for priority in priority_labels:
+            row.append(df[(df[priority]) & (df[label])])
+        table.append(row)
+    table = pd.DataFrame(table, index=labels, columns=priority_labels)
+    table = table.applymap(
+        lambda y: "\n".join(
+            y.apply(lambda x: "[{}]({})".format(x["Name"], x["URL"]), axis=1).values
+        )
+    )
+    return table
+
+
+def create_milestone_label_matrix(df, exclude_milestones=None):
+    if exclude_milestones:
+        df = df[~df["Milestone"].isin(exclude_milestones)]
+    priority_labels = ["High Priority", "Medium Priority", "Low Priority"]
+    labels = list(df.columns[4:])
+    labels = sorted([x for x in labels if x not in priority_labels])
+    milestones = sorted(list(df[~pd.isnull(df["Milestone"])]["Milestone"].unique()))
+
+    table = []
+    for label in labels:
+        row = []
+        for milestone in milestones:
+            row.append(df[(df["Milestone"] == milestone) & (df[label])])
+        table.append(row)
+    table = pd.DataFrame(table, index=labels, columns=milestones)
+    table = table.applymap(
+        lambda y: "\n".join(
+            y.apply(lambda x: "[{}]({})".format(x["Name"], x["URL"]), axis=1).values
+        )
+    )
+    return table

{math_spec_mapping-0.3.16 → math_spec_mapping-0.3.17}/src/math_spec_mapping/Reports/markdown.py

@@ -788,6 +788,12 @@ def write_state_variables_markdown_reports(ms, path, state, add_metadata=True):
             out += variable.domain
         out += "\n\n"
 
+        out += "Updated By:\n"
+        for i, x in enumerate(sorted(variable.updated_by, key=lambda x: x.name)):
+            out += "{}. [[{}]]".format(i + 1, x.name)
+            out += "\n"
+        out += "\n"
+
         with open(
             "{}/State Variables/{}.md".format(
                 path, "{}-{}".format(state.name, variable.name)

{math_spec_mapping-0.3.16 → math_spec_mapping-0.3.17}/src/math_spec_mapping/__init__.py

@@ -30,6 +30,12 @@ from .Reports import (
     write_parameter_table_markdown,
 )
 from .schema import schema
-from .Convenience import remove_dummy_repo_components, write_scaffold_to_github_issues
+from .Convenience import (
+    remove_dummy_repo_components,
+    write_scaffold_to_github_issues,
+    find_open_issues,
+    create_priority_label_matrix,
+    create_milestone_label_matrix,
+)
 
 # from .Convenience import write_top_level_json_description

{math_spec_mapping-0.3.16 → math_spec_mapping-0.3.17/src/math_spec_mapping.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: math-spec-mapping
-Version: 0.3.16
+Version: 0.3.17
 Summary: A library for easy mapping of mathematical specifications.
 Author-email: Sean McOwen <Sean@Block.Science>
 Classifier: Programming Language :: Python :: 3

math_spec_mapping-0.3.16/src/math_spec_mapping/Convenience/__init__.py

@@ -1,3 +0,0 @@
-# from .documentation import write_top_level_json_description
-from .starter import remove_dummy_repo_components
-from .github import write_scaffold_to_github_issues

math_spec_mapping-0.3.16/src/math_spec_mapping/Convenience/github.py

@@ -1,34 +0,0 @@
-import os
-import requests
-
-
-def write_scaffold_to_github_issues(
-    scaffolder_folder, repo_owner, repository_name, access_token
-):
-    folders = [
-        x
-        for x in os.listdir(scaffolder_folder)
-        if os.path.isdir(scaffolder_folder + "/" + x)
-    ]
-    headers = {
-        "Accept": "application/vnd.github+json",
-        "X-GitHub-Api-Version": "2022-11-28",
-        "Authorization": "Bearer {}".format(access_token),
-    }
-    for folder in folders:
-        issue_name = "Write {} from MSML Scaffold".format(folder)
-        checklist = [
-            x[:-3]
-            for x in os.listdir(scaffolder_folder + "/" + folder)
-            if x.endswith(".md")
-        ]
-        checklist = ["- [ ] " + x for x in checklist]
-        checklist = "\n".join(checklist)
-
-        requests.post(
-            "https://api.github.com/repos/{}/{}/issues".format(
-                repo_owner, repository_name
-            ),
-            headers=headers,
-            json={"title": issue_name, "body": checklist},
-        )