course-setup 3.0.5__tar.gz → 3.0.7__tar.gz

{course_setup-3.0.5 → course_setup-3.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: course-setup
-Version: 3.0.5
+Version: 3.0.7
 Summary: CLI tools for setting up and retiring GitHub-backed course repositories
 Author: Reuven Lerner
 Author-email: Reuven Lerner <reuven@lerner.co.il>
@@ -177,6 +177,10 @@ retire-course ./Acme-2026-03 ./Beta-2026-03 ./Gamma-2026-02
 
 If any directory fails, the rest are still processed and errors are reported at the end.
 
+> **Tip:** run `retire-course` from the *parent* of the course directory, not
+> from inside it. If you're already inside, the command detects it and tells
+> you to `cd ..` rather than failing with a confusing error.
+
 ### `archive-course` — Create a zip archive of a course
 
 ```bash
@@ -188,12 +192,13 @@ archive-course ./Acme-python-intro-2026-03
 | `--output`, `-o` | Custom output zip path (defaults to `{dirname}.zip`) |
 | `--no-html` | Skip HTML export of Jupyter notebooks |
 
-For Jupyter notebooks, `archive-course` exports each `.ipynb` to HTML via
-`nbconvert` and includes both the `.ipynb` and `.html` files in the zip. Use
-`--no-html` to skip the HTML export. The archive excludes `.git`, `.venv`,
-`__pycache__`, and `.ipynb_checkpoints` directories. After creating the
-archive, a summary is printed showing the archive path, file count, size, and
-which notebooks were included.
+This archives **all files** in the course directory (`.py`, `.csv`, `.toml`,
+notebooks, etc.), excluding `.git`, `.venv`, `__pycache__`, and
+`.ipynb_checkpoints` directories. For Jupyter notebooks, each `.ipynb` is also
+exported to HTML via `nbconvert` and the `.html` is included alongside the
+original; use `--no-html` to skip the HTML export. After creating the archive,
+a summary is printed listing the archive path, file count, size, notebooks,
+and all other included files.
 
 ### `unretire-course` — Restore a retired course
 

{course_setup-3.0.5 → course_setup-3.0.7}/README.md

@@ -157,6 +157,10 @@ retire-course ./Acme-2026-03 ./Beta-2026-03 ./Gamma-2026-02
 
 If any directory fails, the rest are still processed and errors are reported at the end.
 
+> **Tip:** run `retire-course` from the *parent* of the course directory, not
+> from inside it. If you're already inside, the command detects it and tells
+> you to `cd ..` rather than failing with a confusing error.
+
 ### `archive-course` — Create a zip archive of a course
 
 ```bash
@@ -168,12 +172,13 @@ archive-course ./Acme-python-intro-2026-03
 | `--output`, `-o` | Custom output zip path (defaults to `{dirname}.zip`) |
 | `--no-html` | Skip HTML export of Jupyter notebooks |
 
-For Jupyter notebooks, `archive-course` exports each `.ipynb` to HTML via
-`nbconvert` and includes both the `.ipynb` and `.html` files in the zip. Use
-`--no-html` to skip the HTML export. The archive excludes `.git`, `.venv`,
-`__pycache__`, and `.ipynb_checkpoints` directories. After creating the
-archive, a summary is printed showing the archive path, file count, size, and
-which notebooks were included.
+This archives **all files** in the course directory (`.py`, `.csv`, `.toml`,
+notebooks, etc.), excluding `.git`, `.venv`, `__pycache__`, and
+`.ipynb_checkpoints` directories. For Jupyter notebooks, each `.ipynb` is also
+exported to HTML via `nbconvert` and the `.html` is included alongside the
+original; use `--no-html` to skip the HTML export. After creating the archive,
+a summary is printed listing the archive path, file count, size, notebooks,
+and all other included files.
 
 ### `unretire-course` — Restore a retired course
 

{course_setup-3.0.5 → course_setup-3.0.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
     name = "course-setup"
-    version = "3.0.5"
+    version = "3.0.7"
     description = "CLI tools for setting up and retiring GitHub-backed course repositories"
     readme = "README.md"
     requires-python = ">=3.13"

{course_setup-3.0.5 → course_setup-3.0.7}/src/setup_course_github/archive_course.py

@@ -88,6 +88,17 @@ def archive_course(
         else f"{zip_size / (1024 * 1024):.1f} MB"
     )
 
+    # Collect non-notebook, non-HTML files for the summary
+    notebook_names = {nb.name for nb in notebooks}
+    html_names = {nb.with_suffix(".html").name for nb in notebooks}
+    with zipfile.ZipFile(zip_path, "r") as zf:
+        other_files = sorted(
+            Path(name).name
+            for name in zf.namelist()
+            if Path(name).name not in notebook_names
+            and Path(name).name not in html_names
+        )
+
     # Print summary
     print(f"Archive created: {zip_path}")
     print(f"Files: {file_count}")
@@ -104,6 +115,11 @@ def archive_course(
     if export_html and html_exported > 0:
         print(f"HTML exports: {html_exported}")
 
+    if other_files:
+        print("Other files:")
+        for name in other_files:
+            print(f"  {name}")
+
     return zip_path
 
 

{course_setup-3.0.5 → course_setup-3.0.7}/src/setup_course_github/retire_course.py

@@ -14,6 +14,36 @@ from setup_course_github import __author__, __email__, __version__, get_github
 from setup_course_github.config import load_config
 
 
+class InsideCourseDirectoryError(RuntimeError):
+    """Raised when a command is run from inside the course directory it targets."""
+
+
+def _check_not_inside_course(dirname: str) -> None:
+    """Raise InsideCourseDirectoryError if the user is inside *dirname*.
+
+    Two cases are detected:
+      1. *dirname* resolves to the current working directory (e.g. ``.`` or
+         the absolute path of cwd).
+      2. *dirname* does not exist relative to cwd, but its basename matches
+         cwd's basename — the user has cd'd into the directory and then
+         passed its bare name on the command line.
+    """
+    cwd = Path.cwd().resolve()
+    target = Path(dirname)
+
+    inside = False
+    if target.exists() and target.resolve() == cwd:
+        inside = True
+    elif not target.exists() and target.name == cwd.name:
+        inside = True
+
+    if inside:
+        raise InsideCourseDirectoryError(
+            f"You appear to be inside '{dirname}'. "
+            "Move up one directory (cd ..) and run the command again."
+        )
+
+
 def get_remote_url(dirname: str) -> str:
     """Return the git remote.origin.url for the repo in dirname."""
     result = subprocess.run(
@@ -126,6 +156,8 @@ def _build_retirement_summary(
 
 def retire_course(dirname: str, keep_public: bool = False) -> None:
     """Move the local directory to the archive, optionally making the repo private."""
+    _check_not_inside_course(dirname)
+
     config = load_config()
 
     remote_url = get_remote_url(dirname)

{course_setup-3.0.5 → course_setup-3.0.7}/src/setup_course_github/unretire_course.py

@@ -6,11 +6,17 @@ import sys
 from pathlib import Path
 
 from setup_course_github import __author__, __email__, __version__, get_github
-from setup_course_github.retire_course import get_remote_url, parse_repo_name
+from setup_course_github.retire_course import (
+    _check_not_inside_course,
+    get_remote_url,
+    parse_repo_name,
+)
 
 
 def unretire_course(dirname: str) -> None:
     """Make the repo public again and move the directory to cwd."""
+    _check_not_inside_course(dirname)
+
     remote_url = get_remote_url(dirname)
     repo_name = parse_repo_name(remote_url)