making-with-code-cli 4.0.0__tar.gz → 4.1.0__tar.gz

{making_with_code_cli-4.0.0 → making_with_code_cli-4.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: making-with-code-cli
-Version: 4.0.0
+Version: 4.1.0
 Summary: Courseware for Making With Code
 License: MIT
 Author: Chris Proctor

{making_with_code_cli-4.0.0 → making_with_code_cli-4.1.0}/making_with_code_cli/helpers.py

@@ -1,5 +1,6 @@
 from pathlib import Path
 from contextlib import contextmanager
+import dateparser
 import os
 
 @contextmanager
@@ -13,3 +14,9 @@ def cd(path):
     finally:
         os.chdir(origin)
 
+def in_bounds(value, minimum=None, maximum=None):
+    return (not minimum or value >= minimum) and (not maximum or value <= maximum)
+
+def date_string(arg):
+    return dateparser.parse(arg, settings={'RETURN_AS_TIMEZONE_AWARE': True})
+

{making_with_code_cli-4.0.0 → making_with_code_cli-4.1.0}/making_with_code_cli/setup/tasks.py

@@ -461,10 +461,8 @@ class GitConfiguration(SetupTask):
         git_config = {"init.defaultBranch": "main"}
         if self.settings.get('editor') in self.editorcmds:
             git_config["core.editor"] = self.editorcmds[self.settings.get('editor')]
-        if self.settings.get('git_name'):
-            git_config["user.name"] = self.settings['git_name']
-        if self.settings.get('git_email'):
-            git_config["user.email"] = self.settings['git_email']
+        git_config["user.name"] = self.settings.get('git_name', self.settings['mwc_username'])
+        git_config["user.email"] = self.settings.get('git_email', 'nobody@makingwithcode.org')
         return git_config
 
 

{making_with_code_cli-4.0.0 → making_with_code_cli-4.1.0}/making_with_code_cli/teach/log.py

@@ -9,7 +9,7 @@ from git import Repo
 from pathlib import Path
 from threading import Thread, Semaphore
 from textwrap import wrap
-import dateparser
+from making_with_code_cli.helpers import date_string, in_bounds
 from making_with_code_cli.teach.student_repos import StudentRepos
 from making_with_code_cli.settings import read_settings
 from making_with_code_cli.teach.setup import check_required_teacher_settings
@@ -22,31 +22,27 @@ from making_with_code_cli.styles import (
     error,
 )
 
-def date_string(arg):
-    return dateparser.parse(arg, settings={'RETURN_AS_TIMEZONE_AWARE': True})
-
 @click.command()
 @click.option("--config", help="Path to config file (default: ~/.mwc)")
-@click.option('-g', "--group", help="Filter by group name")
+@click.option('-s', "--section", help="Filter by section name/slug")
 @click.option('-c', "--course", help="Filter by course name")
 @click.option('-u', "--user", help="Filter by username")
 @click.option('-n', "--unit", help="Filter by unit name/slug")
 @click.option('-m', "--module", help="Filter by module name/slug")
-@click.option('-s', "--start", type=date_string, help="Start datetime")
-@click.option('-e', "--end", type=date_string, help="End datetime")
+@click.option('-B', "--begin", type=date_string, help="Start datetime")
+@click.option('-C', "--end", type=date_string, help="End datetime")
 @click.option('-U', "--update", is_flag=True, help="Update repos first")
 @click.option('-t', "--threads", type=int, default=8, help="Maximum simultaneous threads")
-def log(config, group, course, user, unit, module, start, end, update, threads):
+def log(config, section, course, user, unit, module, begin, end, update, threads):
     "Show repo logs"
     if update:
         from making_with_code_cli.teach.update import update as update_task
-        update_task.callback(config, group, course, user, unit, module, threads)
+        update_task.callback(config, section, course, user, unit, module, threads)
     settings = read_settings(config)
     if not check_required_teacher_settings(settings):
         return
     repos = StudentRepos(settings, threads)
-    get_commits = get_repo_commits_factory(start, end)
-    results = repos.apply(get_commits, group=group, course=course, user=user, 
+    results = repos.apply(get_commits, section=section, course=course, user=user, 
             unit=unit, module=module, status_message="Collecting logs")
     for repo in results:
         click.echo(address('-' * 80))
@@ -54,23 +50,20 @@ def log(config, group, course, user, unit, module, start, end, update, threads):
         for commit in repo['commits']:
             click.echo(info(format_commit(commit), preformatted=True))
 
-def get_repo_commits_factory(start, end):
-    def get_repo_commits(semaphore, results, group, username, path, token):
-        "Gets commits from repo"
-        semaphore.acquire()
-        if path.exists():
-            repo = Repo(path)
-            commits = []
-            for commit in repo.iter_commits():
-                if in_bounds(commit.committed_datetime, start, end):
-                    commits.append(commit)
-            if commits:
-                results.append({"path": path, "commits": commits})
-        semaphore.release()
-    return get_repo_commits
-
-def in_bounds(value, minimum=None, maximum=None):
-    return (not minimum or value >= minimum) and (not maximum or value <= maximum)
+def get_commits(semaphore, results, section, username, begin, end, path, token):
+    "Gets commits from repo"
+    semaphore.acquire()
+    if path.exists():
+        repo = Repo(path)
+        selected_commits = []
+        commits = repo.iter_commits(reverse=True)
+        first_commit = next(commits)
+        for commit in commits:
+            if in_bounds(commit.committed_datetime, begin, end):
+                selected_commits.append(commit)
+        if selected_commits:
+            results.append({"path": path, "commits": selected_commits})
+    semaphore.release()
 
 def format_commit(commit):
     return '\n'.join([

{making_with_code_cli-4.0.0 → making_with_code_cli-4.1.0}/making_with_code_cli/teach/section/__init__.py

@@ -9,6 +9,7 @@ from making_with_code_cli.styles import (
 from making_with_code_cli.teach.setup import check_required_teacher_settings
 from making_with_code_cli.teach.section.create import create_section
 from making_with_code_cli.teach.section.edit import edit_section
+from making_with_code_cli.teach.section.show import show_section
 
 @click.group(invoke_without_command=True)
 @click.pass_context
@@ -42,4 +43,5 @@ def summarize_sections(section_data):
 
 section.add_command(create_section)
 section.add_command(edit_section)
+section.add_command(show_section)
 

making_with_code_cli-4.1.0/making_with_code_cli/teach/section/show.py

@@ -0,0 +1,53 @@
+import click
+from csv import DictWriter
+from making_with_code_cli.settings import read_settings
+from making_with_code_cli.mwc_accounts_api import MWCAccountsAPI
+from making_with_code_cli.styles import (
+    address, 
+    error,
+    info,
+    question,
+)
+
+@click.command('show')
+@click.argument("slug")
+@click.option("--config", help="Path to config file (default: ~/.mwc)")
+@click.option("-o", "--outfile", help="Save results as csv")
+def show_section(config, slug, outfile):
+    "Show section details"
+    settings = read_settings(config)
+    api = MWCAccountsAPI(settings.get('mwc_accounts_url'))
+    params = {"slug": slug}
+    response = api.get_roster(settings.get('mwc_accounts_token'))
+    try:
+        section = get_section(response, slug)
+    except ValueError as err:
+        click.echo(error(str(err)))
+    if outfile:
+        students = section['student_tokens']
+        result = [{"username": s, "git_token": t, "section": slug} for s, t in students.items()]
+        if not result:
+            click.echo(error(f"Nothing to write; there are no students in {slug}."))
+            return
+        with open(outfile, "w") as fh:
+            writer = DictWriter(fh, result[0].keys())
+            writer.writeheader()
+            writer.writerows(result)
+    else:
+        click.echo(info(f"name: {section['name']}"))
+        click.echo(info(f"slug: {section['slug']}"))
+        click.echo(info(f"course: {section['course_name']}"))
+        click.echo(info(f"curriculum site: {section['curriculum_site_url']}"))
+        click.echo(info(f"join code: {section['code']}"))
+        if section['student_tokens']:
+            click.echo(info("students:"))
+            for student in sorted(section['student_tokens'].keys()):
+                click.echo(info(f" - {student}"))
+        else:
+            click.echo(info("students: []"))
+
+def get_section(roster, slug):
+    for section in roster['teacher_sections']:
+        if section['slug'] == slug:
+            return section
+    raise ValueError(f"Invalid section {slug}")

{making_with_code_cli-4.0.0 → making_with_code_cli-4.1.0}/making_with_code_cli/teach/status.py

@@ -5,6 +5,7 @@ from tabulate import tabulate
 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.helpers import date_string
 from making_with_code_cli.teach.student_repo_functions import (
     count_commits,
     count_changed_py_lines,
@@ -41,8 +42,10 @@ measures = {
 @click.option("-o", "--outfile", help="Save results as csv")
 @click.option('-U', "--update", is_flag=True, help="Update repos first")
 @click.option('-t', "--threads", type=int, default=8, help="Maximum simultaneous threads")
+@click.option('-B', "--begin", type=date_string, help="Begin date")
+@click.option('-C', "--end", type=date_string, help="End date")
 def status(config, section, course, user, unit, module, measure, anonymous, short, 
-        outfile, update, threads):
+        outfile, update, threads, begin, end):
     "Show status of student repos by module"
     if update:
         from making_with_code_cli.teach.update import update as update_task
@@ -52,8 +55,17 @@ def status(config, section, course, user, unit, module, measure, anonymous, shor
         return
     repos = StudentRepos(settings, threads)
     measure_status_message, measure_fn = measures[measure]
-    results = repos.apply(measure_fn, section=section, course=course, user=user, 
-            unit=unit, module=module, status_message=measure_status_message)
+    results = repos.apply(
+        measure_fn, 
+        section=section, 
+        course=course, 
+        user=user, 
+        unit=unit, 
+        module=module, 
+        begin=begin,
+        end=end,
+        status_message=measure_status_message
+    )
     recursive_dict = lambda: defaultdict(recursive_dict)
     results_dict = recursive_dict()
     for r in results:

{making_with_code_cli-4.0.0 → making_with_code_cli-4.1.0}/making_with_code_cli/teach/student_repo_functions.py

@@ -2,6 +2,7 @@ import os
 from subprocess import run
 from git import Repo
 from making_with_code_cli.teach.gitea_api.api import GiteaTeacherApi
+from making_with_code_cli.helpers import in_bounds
 
 MWC_GIT_PROTOCOL = "https"
 MWC_GIT_SERVER = "git.makingwithcode.org"
@@ -9,7 +10,7 @@ MWC_GIT_SERVER = "git.makingwithcode.org"
 def run_in_repo(command, cwd):
     return run(command, cwd=cwd, shell=True, capture_output=True, text=True)
 
-def update_repo(semaphore, results, section, username, path, token):
+def update_repo(semaphore, results, section, username, begin, end, path, token):
     semaphore.acquire()
     git_api = GiteaTeacherApi()
     if path.exists():
@@ -25,31 +26,38 @@ def update_repo(semaphore, results, section, username, path, token):
         results.append({"action": "clone", "path": path, "process": process})
     semaphore.release()
 
-def count_commits(semaphore, results, section, username, path, token):
+def count_commits(semaphore, results, section, username, begin, end, path, token):
     "Counts commits in repo"
     semaphore.acquire()
     if path.exists():
         repo = Repo(path)
+        commits = repo.iter_commits(reverse=True)
+        first_commit = next(commits)
+        n = 0
+        for commit in commits:
+            if in_bounds(commit.committed_datetime, begin, end):
+                n += 1
         results.append({
             "section": section, 
             "username": username, 
             "module": path.name, 
-            "score": len(list(repo.iter_commits())) - 1
+            "score": n, 
         })
     semaphore.release()
 
-def count_changed_py_lines(semaphore, results, section, username, path, token):
+def count_changed_py_lines(semaphore, results, section, username, begin, end, path, token):
     "Counts lines changed in Python files across all commits in repo"
     semaphore.acquire()
     if path.exists():
         repo = Repo(path)
         changed_lines = 0
-        commits = repo.iter_commits()
+        commits = repo.iter_commits(reverse=True)
         first_commit = next(commits)
         for commit in commits:
-            for f, stats in commit.stats.files.items():
-                if f.endswith(".py"):
-                    changed_lines += stats['lines']
+            if in_bounds(commit.committed_datetime, begin, end):
+                for f, stats in commit.stats.files.items():
+                    if f.endswith(".py"):
+                        changed_lines += stats['lines']
         results.append({
             "section": section, 
             "username": username, 
@@ -58,18 +66,19 @@ def count_changed_py_lines(semaphore, results, section, username, path, token):
         })
     semaphore.release()
 
-def count_changed_md_lines(semaphore, results, section, username, path, token):
+def count_changed_md_lines(semaphore, results, section, username, begin, end, path, token):
     "Counts lines changed in Python files across all commits in repo"
     semaphore.acquire()
     if path.exists():
         repo = Repo(path)
         changed_lines = 0
-        commits = repo.iter_commits()
+        commits = repo.iter_commits(reverse=True)
         first_commit = next(commits)
         for commit in commits:
-            for f, stats in commit.stats.files.items():
-                if f.endswith(".md"):
-                    changed_lines += stats['lines']
+            if in_bounds(commit.committed_datetime, begin, end):
+                for f, stats in commit.stats.files.items():
+                    if f.endswith(".md"):
+                        changed_lines += stats['lines']
         results.append({
             "section": section, 
             "username": username, 
@@ -78,7 +87,7 @@ def count_changed_md_lines(semaphore, results, section, username, path, token):
         })
     semaphore.release()
 
-def module_completion(semaphore, results, section, username, path, token):
+def module_completion(semaphore, results, section, username, begin, end, path, token):
     "Returns a [0..1] ratio of module completion, based on tests."
     semaphore.acquire()
     if path.exists():

{making_with_code_cli-4.0.0 → making_with_code_cli-4.1.0}/making_with_code_cli/teach/student_repos.py

@@ -14,7 +14,7 @@ class StudentRepos:
         self.max_threads = max_threads
 
     def apply(self, function, section=None, course=None, user=None, 
-            unit=None, module=None, status_message=""):
+            unit=None, module=None, begin=None, end=None, status_message=""):
         """Applies function to repo paths matching args, and returns the result.
         The function should take (sem, result, g, user, path, token).
         Application is in parallel, using up to max_threads.
@@ -23,7 +23,7 @@ class StudentRepos:
         results = []
         threads = []
         for g, user, path, token in self.iter_repos(section, course, user, unit, module):
-            thread = Thread(target=function, args=(sem, results, g, user, path, token))
+            thread = Thread(target=function, args=(sem, results, g, user, begin, end, path, token))
             thread.start()
             threads.append(thread)
         for i, thread in enumerate(threads):

{making_with_code_cli-4.0.0 → making_with_code_cli-4.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "making-with-code-cli"
-version = "4.0.0"
+version = "4.1.0"
 description = "Courseware for Making With Code"
 authors = [
     {name = "Chris Proctor",email = "chris@chrisproctor.net"}