math-spec-mapping 0.3.13__tar.gz → 0.3.14__tar.gz

{math_spec_mapping-0.3.13/src/math_spec_mapping.egg-info → math_spec_mapping-0.3.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: math-spec-mapping
-Version: 0.3.13
+Version: 0.3.14
 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.13 → math_spec_mapping-0.3.14}/pyproject.toml

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

{math_spec_mapping-0.3.13 → math_spec_mapping-0.3.14}/src/math_spec_mapping/Convenience/__init__.py

@@ -1,2 +1,3 @@
 # 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.14/src/math_spec_mapping/Convenience/github.py

@@ -0,0 +1,34 @@
+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},
+        )

{math_spec_mapping-0.3.13 → math_spec_mapping-0.3.14}/src/math_spec_mapping/Reports/markdown.py

@@ -374,6 +374,12 @@ def write_control_action_markdown_report(ms, path, control_action, add_metadata=
         out += "\n"
     out += "\n"
 
+    out += "## Parameters Used\n"
+    for i, x in enumerate(sorted(control_action.parameters_used, key=lambda x: x)):
+        out += "{}. [[{}]]".format(i + 1, x)
+        out += "\n"
+    out += "\n"
+
     if control_action.control_action_options:
         out += "## Control Action Options:\n"
         for i, x in enumerate(control_action.control_action_options):
@@ -509,6 +515,7 @@ def write_parameter_markdown_report(ms, path, parameter, add_metadata=True):
             )
 
     out += "Description: {}\n\n".format(param.description)
+    out += "Type: [[{}]]\n\n".format(param.variable_type.name)
     out += "Symbol: {}\n\n".format(param.symbol)
     out += "Domain: {}\n\n".format(param.domain)
     out += "Parameter Class: {}\n\n".format(param.parameter_class)

{math_spec_mapping-0.3.13 → math_spec_mapping-0.3.14}/src/math_spec_mapping/__init__.py

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

{math_spec_mapping-0.3.13 → math_spec_mapping-0.3.14/src/math_spec_mapping.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: math-spec-mapping
-Version: 0.3.13
+Version: 0.3.14
 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.13 → math_spec_mapping-0.3.14}/src/math_spec_mapping.egg-info/SOURCES.txt

@@ -27,6 +27,7 @@ src/math_spec_mapping/Classes/Type.py
 src/math_spec_mapping/Classes/__init__.py
 src/math_spec_mapping/Convenience/__init__.py
 src/math_spec_mapping/Convenience/documentation.py
+src/math_spec_mapping/Convenience/github.py
 src/math_spec_mapping/Convenience/starter.py
 src/math_spec_mapping/Load/__init__.py
 src/math_spec_mapping/Load/action_transmission_channel.py