making-with-code-cli 2.0.5__tar.gz → 2.1.0__tar.gz

{making_with_code_cli-2.0.5 → making_with_code_cli-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: making-with-code-cli
-Version: 2.0.5
+Version: 2.1.0
 Summary: Courseware for Making With Code
 Home-page: https://github.com/cproctor/making-with-code-courseware
 License: MIT

{making_with_code_cli-2.0.5 → making_with_code_cli-2.1.0}/making_with_code_cli/teach/__init__.py

@@ -3,6 +3,7 @@ from making_with_code_cli.teach.setup import setup
 from making_with_code_cli.teach.update import update
 from making_with_code_cli.teach.status import status
 from making_with_code_cli.teach.log import log
+from making_with_code_cli.teach.patch import patch
 from making_with_code_cli.teach.test import test
 
 @click.group()
@@ -13,4 +14,5 @@ teach.add_command(setup)
 teach.add_command(update)
 teach.add_command(status)
 teach.add_command(log)
+teach.add_command(patch)
 teach.add_command(test)

making_with_code_cli-2.1.0/making_with_code_cli/teach/assess.py

@@ -0,0 +1,30 @@
+# teach/assess.py
+# ---------------
+# Implements `mwc teach assess`.
+# This task iterates over student repos and assesses them.
+# 
+# New settings:
+# - I need some way of specifying a search root for assessment repos.
+#   Possibly teacher_assessment_repo_dir. We would search this directory
+#   for a directory having the same name as the lab being assessed. Within
+#   this direcory, we would locate assessment_policy.toml and possibly
+#   modules for testing. It would be recommended that assessment materials
+#   not be shared with students, but instead to be kept in an assessment
+#   branch of the base repos which are forked.
+# Assessment: 
+# - A student module (lab, project, or problem set) is assessed according
+#   to a policy, which defines:
+#   - A front matter comment
+#   - The type of assessment (completion, points, or rubric)
+#   - The method of scoring:
+#     - Using a measure (e.g. number of commits, lines of code changed)
+#     - Using automated tests
+#     - Qualitatively through teacher interaction
+# - Assessment is recorded in `assessment.md`, in a student's module repo.
+#   Machine-readable information is stored in TOML-based front matter, using
+#   an [[assessment]] table for each time assessment occurs. Each [[assessment]]
+#   has keys for date and score. The type of score depends on the type of assessment, 
+#   and could be a string (effectively an enum) representing completion, a ratio
+#   (a two-integer array specifying points awarded and points possible), or 
+#   a sub-table for rubric scores.
+# - Assessment should be repeatable, with subsequent assessments appended to the record.

making_with_code_cli-2.1.0/making_with_code_cli/teach/patch.py

@@ -0,0 +1,91 @@
+# teach/patch.py
+# ---------------
+# Implements `mwc teach patch`.
+# This task patches a module for all students in a group. 
+# Patching is most useful when a change needs to be applied 
+# to a module after a course has started, and students each
+# have their own copy of the repo.
+
+import click
+import git
+from git import Repo
+from making_with_code_cli.settings import read_settings
+from making_with_code_cli.teach.setup import check_required_teacher_settings
+from making_with_code_cli.teach.student_repos import StudentRepos
+from making_with_code_cli.teach.update import update as update_task
+from making_with_code_cli.styles import success, error
+
+GIT_REMOTE_NAME = "origin"
+
+@click.command()
+@click.argument("patch")
+@click.argument("group")
+@click.argument("module")
+@click.option("--config", help="Path to config file (default: ~/.mwc)")
+@click.option('-c', "--course", help="Filter by course name")
+@click.option('-u', "--user", help="Filter by username")
+@click.option('-n', "--no-commit", is_flag=True, help="Commit and push changes")
+@click.option('-m', "--message", default="Applying patch", help="Commit message")
+@click.option('-t', "--threads", type=int, default=8, help="Maximum simultaneous threads")
+def patch(patch, group, module, config, course, user, no_commit, message, threads):
+    settings = read_settings(config)
+    if not check_required_teacher_settings(settings):
+        return
+    update_task.callback(config, group, course, user, None, module, threads)
+    apply_patch = apply_patch_factory(patch, message, no_commit)
+    repos = StudentRepos(settings, threads)
+    results = repos.apply(apply_patch, group=group, course=course, module=module, 
+            user=user, status_message=f"Applying patch {patch}")
+    for result in results:
+        if result['success']:
+            click.echo(success(f"SUCCESS: {result['path']}", preformatted=True))
+        else:
+            click.echo(error(f"ERROR: {result['path']}: {result['message']}", preformatted=True))
+
+def apply_patch_factory(patch, commit_message, no_commit=False):
+    """Creates a function which will apply a patch to a repo. 
+    """
+    def apply_patch(semaphore, results, group, username, path, token):
+        semaphore.acquire()
+        if path.exists():
+            repo = Repo(path)
+            if has_staged_changes(repo):
+                results.append({
+                    "path": path, 
+                    "success": False, 
+                    "message": "Repo has staged changes."
+                })
+            elif has_unstaged_changes(repo):
+                results.append({
+                    "path": path, 
+                    "success": False, 
+                    "message": "Repo has unstaged changes."
+                })
+            else:
+                try:
+                    repo.git.apply(patch)
+                except git.exc.GitCommandError as e:
+                    results.append({"path": path, "success": False, "message": str(e)})
+                    return
+                if not no_commit:
+                    try:
+                        repo.git.add(update=True)
+                        repo.index.commit(commit_message)
+                        remote = repo.remote(name=GIT_REMOTE_NAME)
+                        remote.push()
+                    except Exception as e:
+                        results.append({"path": path, "success": False, "message": str(e)})
+                        return
+                results.append({"path": path, "success": True})
+        semaphore.release()
+    return apply_patch
+
+def has_staged_changes(repo):
+    staged_changes = repo.index.diff("HEAD")
+    return len(staged_changes) > 0
+
+def has_unstaged_changes(repo):
+    unstaged_changes = repo.index.diff(None)
+    return len(unstaged_changes) > 0
+
+

{making_with_code_cli-2.0.5 → making_with_code_cli-2.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "making-with-code-cli"
-version = "2.0.5"
+version = "2.1.0"
 description = "Courseware for Making With Code"
 authors = ["Chris Proctor <chris@chrisproctor.net>"]
 license = "MIT"