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

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: making-with-code-cli
-Version: 2.0.5
+Version: 2.2.0
 Summary: Courseware for Making With Code
 Home-page: https://github.com/cproctor/making-with-code-courseware
 License: MIT
@@ -11,6 +11,8 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: PyYAML (>=6.0,<7.0)
 Requires-Dist: click (>=8.0.3,<9.0.0)
 Requires-Dist: dateparser (>=1.1.8,<2.0.0)
@@ -18,6 +20,7 @@ Requires-Dist: gitpython (>=3.1.32,<4.0.0)
 Requires-Dist: requests (>=2.27.1,<3.0.0)
 Requires-Dist: tabulate (>=0.9.0,<0.10.0)
 Requires-Dist: toml (>=0.10.2,<0.11.0)
+Requires-Dist: tqdm (>=4.67.1,<5.0.0)
 Project-URL: issues, https://github.com/cproctor/making-with-code-courseware/issues
 Description-Content-Type: text/markdown
 

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

@@ -3,7 +3,8 @@ 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.test import test
+from making_with_code_cli.teach.patch import patch
+from making_with_code_cli.teach.check import check
 
 @click.group()
 def teach():
@@ -13,4 +14,5 @@ teach.add_command(setup)
 teach.add_command(update)
 teach.add_command(status)
 teach.add_command(log)
-teach.add_command(test)
+teach.add_command(patch)
+teach.add_command(check)

making_with_code_cli-2.2.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.2.0/making_with_code_cli/teach/check/__init__.py

@@ -0,0 +1,31 @@
+import click
+import requests
+from pathlib import Path
+from tqdm import tqdm
+from making_with_code_cli.curriculum import get_curriculum
+from making_with_code_cli.teach.check.check_module import TestMWCModule
+
+@click.command()
+@click.argument("url")
+@click.argument("course_name")
+@click.argument("repo_dir", type=click.Path(exists=True, file_okay=False, writable=True, 
+        path_type=Path))
+def check(url, course_name, repo_dir):
+    "Test MWC curriuclum and modules"
+    curriculum = get_curriculum(url, course_name)
+    test_cases = []
+    for unit in curriculum['units']:
+        for module in unit['modules']:
+            full_slug = '/'.join([curriculum['slug'], unit['slug'], module['slug']])
+            path = repo_dir / full_slug
+            test_cases.append((module, path, full_slug))
+    results = []
+    for mod, path, slug in tqdm(test_cases):
+        test = TestMWCModule(module, path)
+        errors = test.run()
+        if errors:
+            results.append((slug, errors))
+    for slug, errors in results:
+        print(slug)
+        for error in errors:
+            print(f" - {error}")

making_with_code_cli-2.2.0/making_with_code_cli/teach/check/check_module.py

@@ -0,0 +1,71 @@
+# test_module.py
+# --------------
+# Defines a test case for a MWC module.
+
+from pathlib import Path
+import requests
+import toml
+from git import Repo, InvalidGitRepositoryError, GitCommandError
+
+DEFAULT_BRANCH_NAME = "main"
+PYTHON_VERSION = "^3.10"
+
+class TestCouldNotContinue(Exception):
+    pass
+
+class TestMWCModule:
+
+    def __init__(self, module_metadata, repo_path):
+        self.module_metadata = module_metadata
+        self.repo_path = repo_path
+
+    def run(self):
+        self.errors = []
+        try:
+            self.fetch_repo()
+            self.test_curriculum_page_exists()
+            self.test_has_commit_template()
+            self.test_module_metadata()
+        except TestCouldNotContinue as err:
+            self.errors.append(str(err))
+        return self.errors
+
+    def fetch_repo(self):
+        """Ensures the repo is present and up to date.
+        """
+        if self.repo_path.exists():
+            try: 
+                repo = Repo(self.repo_path)
+                repo.remotes.origin.pull()
+            except InvalidGitRepositoryError:
+                raise TestCouldNotContinue(f"{self.module_path} exists but is not a repo")
+        else:
+            try:
+                repo = Repo.clone_from(self.module_metadata['repo_url'], self.repo_path)
+            except GitCommandError:
+                raise TestCouldNotContinue("Could not clone repo")
+        if not repo.active_branch.name == DEFAULT_BRANCH_NAME:
+            self.errors.append(f"Default branch is not '{DEFAULT_BRANCH_NAME}'")
+
+    def test_curriculum_page_exists(self):
+        page_url = self.module_metadata['url']
+        response = requests.get(page_url)
+        if not response.ok:
+            self.errors.append(f"Curriculum page missing: {page_url}")
+
+    def test_has_commit_template(self):
+        ct = self.repo_path / ".commit_template"
+        if not ct.exists:
+            self.errors.append(".commit_template is missing")
+
+    def test_module_metadata(self):
+        md_file = self.repo_path/"pyproject.toml"
+        if not md_file.exists():
+            self.errors.append(f"pyproject.toml missing")
+            return 
+        md = toml.load(md_file)
+        pyversion = md["tool"]["poetry"]["dependencies"]["python"]
+        if not pyversion == PYTHON_VERSION:
+            self.errors.append(f"python version is {pyversion}, expected {PYTHON_VERSION}")
+        if "dev-dependencies" in md["tool"]["poetry"]:
+            self.errors.append("pyproject.toml has deprecated tool.poetry.dev-dependencies")

making_with_code_cli-2.2.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.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "making-with-code-cli"
-version = "2.0.5"
+version = "2.2.0"
 description = "Courseware for Making With Code"
 authors = ["Chris Proctor <chris@chrisproctor.net>"]
 license = "MIT"
@@ -16,8 +16,20 @@ toml = "^0.10.2"
 tabulate = "^0.9.0"
 gitpython = "^3.1.32"
 dateparser = "^1.1.8"
+tqdm = "^4.67.1"
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.docs]
+optional = true
+
+[tool.poetry.group.docs.dependencies]
+sphinx = "^7.3.7"
+sphinx-rtd-theme = "^2.0.0"
+
+[tool.poetry.group.teacher]
+optional = true
+
+[tool.poetry.group.teacher.dependencies]
+gitpython = "^3.1.44"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

making_with_code_cli-2.0.5/making_with_code_cli/teach/check.py

@@ -1,25 +0,0 @@
-# Checks setup of 
-
-# - Curriculum
-#   - Check out each template directory
-#      - Main branch?
-#      - Has .commit_template?
-#      - Is template?
-
-class MWCModuleTests:
-
-{'teacher_groups': [{'code': 'lai676',
-                     'course_name': 'Making With Code I',
-                     'curriculum_site_url': 'https://makingwithcode.org',
-                     'group_name': 'LAI 676 Summer 2023',
-                     'student_tokens': {'cchung': 'b6f7bbeb34a076c1da7c6a58c9d41e1c1faecb9e',
-                            'finn': '320abfad1c97c78a274a66d1f7cbd651151d7f7d',
-                            'jtoombs': 'aae00b2af1722517efadd5cfc58156696de9626c',
-                            'kodell-hamilton': '66054d1f27ff7b793c3d19b96a1e207105938149',
-                            'lcooper': '31d0d64ecb7182eef437fd33f8eeb7e45f4c32ad',
-                            'mgunsolus': '1f9549e36f44fc710bac82153d972e41b0df2b0f',
-                            'mhall': '8dbab4a23a988bbfab71ff96ee673a03224f90ac',
-                            'pwick': '3e28563be3eba4e9fcd8e9d8ce5abb494fe27d94',
-                            'test_user_lai676': '87bbf8e278b6fa5ead76467810f8e48d93b1b46e',
-                            'tnaber': '00456bd8df3e513e787d113df8992d5c66475c3f'}}],
- 'username': 'chris'}

making_with_code_cli-2.0.5/making_with_code_cli/teach/test/__init__.py

@@ -1,14 +0,0 @@
-import click
-from making_with_code_cli.teach.test.test_module import TestMWCModule
-
-@click.command()
-def test():
-    "Test MWC curriuclum and modules"
-
-    """
-    """
-# - Curriculum
-#   - Check out each template directory
-#      - Main branch?
-#      - Has .commit_template?
-#      - Is template?

making_with_code_cli-2.0.5/making_with_code_cli/teach/test/test_module.py

@@ -1,9 +0,0 @@
-# test_module.py
-# --------------
-# Defines a testcase for a MWC module.
-
-from unittest import TestCase
-
-class TestMWCModule:
-    def __init__(self, module_path):
-        self.module_path = module_path