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

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: making-with-code-cli
-Version: 2.1.0
+Version: 2.2.1
 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.1.0 → making_with_code_cli-2.2.1}/making_with_code_cli/curriculum.py

@@ -7,7 +7,7 @@ from making_with_code_cli.errors import (
 
 LIVE_RELOAD = '<script src="/livereload.js?port=1024&amp;mindelay=10"></script>'
 
-def get_curriculum(mwc_site_url, course_name):
+def get_curriculum(mwc_site_url, course_name=None):
     """Fetches curriculum metadata from the site url specified in settings.
     Returns the curriculum metadata for course_name.
     """
@@ -16,9 +16,12 @@ def get_curriculum(mwc_site_url, course_name):
     if response.ok:
         text = response.text.strip(LIVE_RELOAD)
         metadata = json.loads(text)
-        for course in metadata["courses"]:
-            if course["name"] == course_name:
-                return course
+        if course_name:
+            for course in metadata["courses"]:
+                if course["name"] == course_name:
+                    return course
+        else:
+            return metadata
         raise CurriculumNotFound(mwc_site_url, course_name)
     else:
         raise CurriculumSiteNotAvailable(mwc_site_url)

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

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

making_with_code_cli-2.2.1/making_with_code_cli/teach/check/__init__.py

@@ -0,0 +1,44 @@
+from textwrap import fill
+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("repo_dir", type=click.Path(exists=True, file_okay=False, writable=True, 
+        path_type=Path))
+@click.option("--course", "-c", help="Course name to check")
+@click.option("--module", "-m", help="Module slug to check")
+@click.option("--json", "-j", 'use_json', is_flag=True, help="JSON-structured output")
+def check(url, repo_dir, course, module, use_json):
+    "Test MWC curriuclum and modules"
+    if course:
+        courses = [get_curriculum(url, course)]
+    else:
+        courses = get_curriculum(url)['courses']
+    test_cases = []
+    for course in courses:
+        for unit in course['units']:
+            for mod in unit['modules']:
+                if not module or mod['slug'] == module:
+                    full_slug = '/'.join([course['slug'], unit['slug'], mod['slug']])
+                    path = repo_dir / full_slug
+                    test_cases.append((mod, path, full_slug))
+    results = []
+    if not module:
+        test_cases = tqdm(test_cases)
+    for mod, path, slug in test_cases:
+        test = TestMWCModule(mod, path)
+        errors = test.run()
+        if errors:
+            results.append((slug, errors))
+    if use_json:
+        print([{'module': slug, 'errors': errors} for slug, errors in results])
+    else:
+        for slug, errors in results:
+            print(slug)
+            for error in errors:
+                print(fill(error, width=80, initial_indent="- ", subsequent_indent="  "))

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

@@ -0,0 +1,89 @@
+# test_module.py
+# --------------
+# Defines a test case for a MWC module.
+
+from pathlib import Path
+from subprocess import run
+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_poetry()
+            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_poetry(self):
+        result = run("poetry check", cwd=self.repo_path, shell=True, capture_output=True, 
+                text=True)
+        if result.returncode:
+            for err in result.stderr.split('\n'):
+                if err.strip():
+                    self.errors.append(err.strip())
+
+    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)
+        if not "project" in md:
+            self.errors.append("'project' section missing from pyproject.toml")
+            return
+        if "tool" in md:
+            self.errors.append("Deprecated 'tool' section found in pyproject.toml")
+        pyversion = md['project'].get('requires-python')
+        if not pyversion == PYTHON_VERSION:
+            self.errors.append(f"python version is {pyversion}, expected {PYTHON_VERSION}")
+
+
+
+
+

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "making-with-code-cli"
-version = "2.1.0"
+version = "2.2.1"
 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.1.0/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.1.0/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.1.0/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