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

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

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

{making_with_code_cli-2.2.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.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.0 → making_with_code_cli-2.2.1}/making_with_code_cli/teach/check/check_module.py

@@ -3,12 +3,13 @@
 # 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"
+PYTHON_VERSION = ">=3.10"
 
 class TestCouldNotContinue(Exception):
     pass
@@ -25,6 +26,7 @@ class TestMWCModule:
             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))
@@ -58,14 +60,30 @@ class TestMWCModule:
         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)
-        pyversion = md["tool"]["poetry"]["dependencies"]["python"]
+        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}")
-        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-2.2.1}/pyproject.toml

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

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

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