solrub 0.1.0__tar.gz

solrub-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 higger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

solrub-0.1.0/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.4
+Name: solrub
+Version: 0.1.0
+Summary: Build the student, solution and rubric PDFs of a LaTeX assignment.
+Author-email: higger <matt.higger@gmail.com>
+License-Expression: MIT
+Keywords: latex,pdflatex,teaching,exam,rubric,grading
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Education
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Education
+Classifier: Topic :: Text Processing :: Markup :: LaTeX
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: pts
+Requires-Dist: sum-pts>=0.0.4; extra == "pts"
+Dynamic: license-file
+
+# solrub
+
+Build the student, solution and rubric PDFs of a LaTeX assignment.
+
+One `.tex` source carries all three copies.  `\sol` marks what only the
+answer key shows and `\rub` what only the grading rubric shows; each copy is
+a `pdflatex` run defining a different subset of them.
+
+```bash
+pip install solrub
+```
+
+## Use
+
+```bash
+solrub quiz1a              # quiz1a.pdf, quiz1a_sol.pdf, quiz1a_rub.pdf
+solrub quiz1*              # every version at once
+solrub quiz1/              # every document in a folder
+solrub --no-sol --no-rub blank
+```
+
+All three copies are the default; `--no-sol` and `--no-rub` opt out.  Add
+`-p` to sum the points (needs `pip install "solrub[pts]"`).
+
+Arguments are files, globs or directories, with the `.tex` suffix optional.
+Globs are expanded by the tool rather than left to the shell, so `quiz1*`
+works the same on Windows.  Two filters keep a wide pattern honest: sibling
+builds (`quiz1a.pdf`, `quiz1a_sol.pdf`) collapse onto the `.tex` they came
+from, and a fragment with no `\documentclass` is skipped.  A failed document
+does not stop the rest of the batch; the failures are listed at the end.
+
+## In the document
+
+Three macros divide the source.  `\answer` and `\rubric` are hidden by
+default and revealed by their build; `\exam` is the reverse, student-only
+content such as the blank space left for the work, dropped from both keys.
+
+```latex
+\newcommand{\answer}[1]{}
+\newcommand{\rubric}[1]{}
+\newcommand{\exam}[1]{#1}
+
+\ifdefined\sol
+  \renewcommand{\answer}[1]{#1}
+  \renewcommand{\exam}[1]{}
+\fi
+
+\ifdefined\rub
+  \renewcommand{\rubric}[1]{#1}
+  \renewcommand{\exam}[1]{}
+\fi
+```
+
+## Requires
+
+`pdflatex` on the PATH, and Python 3.9 or newer.

solrub-0.1.0/README.md

@@ -0,0 +1,56 @@
+# solrub
+
+Build the student, solution and rubric PDFs of a LaTeX assignment.
+
+One `.tex` source carries all three copies.  `\sol` marks what only the
+answer key shows and `\rub` what only the grading rubric shows; each copy is
+a `pdflatex` run defining a different subset of them.
+
+```bash
+pip install solrub
+```
+
+## Use
+
+```bash
+solrub quiz1a              # quiz1a.pdf, quiz1a_sol.pdf, quiz1a_rub.pdf
+solrub quiz1*              # every version at once
+solrub quiz1/              # every document in a folder
+solrub --no-sol --no-rub blank
+```
+
+All three copies are the default; `--no-sol` and `--no-rub` opt out.  Add
+`-p` to sum the points (needs `pip install "solrub[pts]"`).
+
+Arguments are files, globs or directories, with the `.tex` suffix optional.
+Globs are expanded by the tool rather than left to the shell, so `quiz1*`
+works the same on Windows.  Two filters keep a wide pattern honest: sibling
+builds (`quiz1a.pdf`, `quiz1a_sol.pdf`) collapse onto the `.tex` they came
+from, and a fragment with no `\documentclass` is skipped.  A failed document
+does not stop the rest of the batch; the failures are listed at the end.
+
+## In the document
+
+Three macros divide the source.  `\answer` and `\rubric` are hidden by
+default and revealed by their build; `\exam` is the reverse, student-only
+content such as the blank space left for the work, dropped from both keys.
+
+```latex
+\newcommand{\answer}[1]{}
+\newcommand{\rubric}[1]{}
+\newcommand{\exam}[1]{#1}
+
+\ifdefined\sol
+  \renewcommand{\answer}[1]{#1}
+  \renewcommand{\exam}[1]{}
+\fi
+
+\ifdefined\rub
+  \renewcommand{\rubric}[1]{#1}
+  \renewcommand{\exam}[1]{}
+\fi
+```
+
+## Requires
+
+`pdflatex` on the PATH, and Python 3.9 or newer.

solrub-0.1.0/pyproject.toml

@@ -0,0 +1,30 @@
+[project]
+name = "solrub"
+version = "0.1.0"
+description = "Build the student, solution and rubric PDFs of a LaTeX assignment."
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "higger", email = "matt.higger@gmail.com" }]
+keywords = ["latex", "pdflatex", "teaching", "exam", "rubric", "grading"]
+classifiers = [
+    "Environment :: Console",
+    "Intended Audience :: Education",
+    "Programming Language :: Python :: 3",
+    "Topic :: Education",
+    "Topic :: Text Processing :: Markup :: LaTeX",
+]
+
+[project.optional-dependencies]
+pts = ["sum-pts>=0.0.4"]
+
+[project.scripts]
+solrub = "solrub:main"
+
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = ["solrub"]

solrub-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

solrub-0.1.0/solrub/__init__.py

@@ -0,0 +1,193 @@
+#!/usr/bin/env python3
+"""Build the student, solution and rubric PDFs of a LaTeX assignment.
+
+One .tex source carries all three copies: the \\sol and \\rub macros mark
+the parts only the answer key and the grading rubric should show, and each
+copy is a pdflatex run that defines a different subset of them.  All three
+are built unless --no-sol or --no-rub says otherwise.
+
+Arguments are files, globs or directories, resolved here rather than left
+to the shell, so quiz1* reaches quiz1a and quiz1b on every platform.  Two
+filters keep a wide pattern honest: sibling builds (quiz1a.pdf,
+quiz1a_sol.pdf) collapse onto the .tex they came from, and a fragment with
+no \\documentclass, e.g. reminder.tex, is skipped.
+"""
+
+import argparse
+import glob
+import importlib.util
+import pathlib
+import re
+import subprocess
+import sys
+from collections.abc import Iterator
+
+__version__ = '0.1.0'
+
+DOCUMENTCLASS = re.compile(r'^\s*\\documentclass', re.MULTILINE)
+
+
+def build_pdf(path: pathlib.Path, jobname: str = None, sol: bool = False,
+              rub: bool = False, clean: bool = True) -> None:
+    """Run pdflatex on one document.
+
+    Args:
+        path: the .tex file, suffix optional
+        jobname: output basename, defaults to the input's
+        sol: define \\sol, revealing the answers
+        rub: define \\rub, revealing the rubric (needs sol too)
+        clean: delete the aux, out and log files afterwards.  A failed
+            run keeps them either way, since the log holds the error.
+
+    Raises:
+        subprocess.CalledProcessError: pdflatex rejected the document
+    """
+    path = pathlib.Path(path).with_suffix('')
+
+    # nonstopmode so a broken document reports and exits rather than
+    # stopping for input, which would strand a whole batch of builds.
+    command = ['pdflatex', '-interaction=nonstopmode']
+    if jobname:
+        command += ['--jobname', jobname]
+    if sol and rub:
+        command += ['\\def\\sol{1} \\def\\rub{1} \\input{' + path.name + '}']
+    elif sol:
+        command += ['\\def\\sol{1} \\input{' + path.name + '}']
+    else:
+        command += [path.name]
+
+    subprocess.run(command, check=True, cwd=path.parent)
+
+    if clean:
+        clean_up(path)
+
+
+def sum_points(path: pathlib.Path) -> None:
+    """Print the point total of a document.
+
+    Raises:
+        SystemExit: the optional sum-pts dependency is not installed
+    """
+    if importlib.util.find_spec('sum_pts') is None:
+        sys.exit('summing points needs sum-pts: pip install "solrub[pts]"')
+
+    command = [
+        sys.executable, '-m', 'sum_pts', f"{path}",
+        '--left', '\\[', '--right', '\\]',
+        '--points', 'pts?', '--prefix', ' *\\\\prob',
+        '-r', '\\(\\d+.?\\d* each\\)',
+        '-r', '\\((\\d+.?\\d*,? ?)+\\)',
+        '-r', '\\{', '-r', '\\}', '-r', ':'
+    ]
+    subprocess.run(command, check=True)
+
+
+def clean_up(path: pathlib.Path) -> None:
+    """Delete the aux, out and log files of a document's three builds."""
+    for stem in [path.stem, f'{path.stem}_sol', f'{path.stem}_rub']:
+        for ext in ['aux', 'out', 'log']:
+            (path.parent / f'{stem}.{ext}').unlink(missing_ok=True)
+
+
+def is_document(path: pathlib.Path) -> bool:
+    """Report whether a .tex file is a whole document, not a fragment."""
+    return bool(DOCUMENTCLASS.search(path.read_text(errors='ignore')))
+
+
+def expand(pattern: str) -> Iterator[pathlib.Path]:
+    """Yield the candidate files one command-line argument names.
+
+    A pattern the shell already expanded arrives as a plain path and passes
+    through; one it left alone is globbed here.  A directory stands for the
+    .tex files directly inside it.
+    """
+    for match in sorted(glob.glob(pattern)) or [pattern]:
+        path = pathlib.Path(match)
+        if path.is_dir():
+            yield from sorted(path.glob('*.tex'))
+        else:
+            yield path
+
+
+def resolve(patterns: list[str]) -> list[pathlib.Path]:
+    """Map command-line arguments onto the .tex files to build.
+
+    Args:
+        patterns: paths, globs or directories, .tex suffix optional
+
+    Returns:
+        paths: the .tex files, deduplicated, in the order named.  A
+            pattern matching several files keeps only the whole documents
+            among them; a file named on its own is built whatever it holds.
+
+    Raises:
+        FileNotFoundError: a pattern matches nothing on disk
+    """
+    paths = []
+    for pattern in patterns:
+        candidates = list(expand(pattern))
+        found = []
+        for candidate in candidates:
+            tex = candidate.with_suffix('.tex')
+            if tex.is_file() and tex not in found:
+                found.append(tex)
+        if len(found) > 1:
+            found = [tex for tex in found if is_document(tex)]
+        if not found:
+            # An existing file with no source of its own is a build the
+            # shell swept in beside it (quiz1a_sol.pdf), so drop it
+            # quietly; a name matching nothing at all is a typo.
+            if not any(candidate.exists() for candidate in candidates):
+                raise FileNotFoundError(
+                    f'no document to build matches: {pattern}')
+            continue
+        paths += [tex for tex in found if tex not in paths]
+    return paths
+
+
+def main() -> None:
+    """Run the command line interface."""
+    parser = argparse.ArgumentParser(
+        prog='solrub',
+        description='Build the student, solution and rubric PDFs of a '
+                    'LaTeX assignment.')
+    parser.add_argument('-s', '--sol', action=argparse.BooleanOptionalAction,
+                        default=True, help='build solution copy')
+    parser.add_argument('-r', '--rub', action=argparse.BooleanOptionalAction,
+                        default=True, help='build rubric copy')
+    parser.add_argument('-p', '--pts', action='store_true', help='sum points')
+    parser.add_argument('-V', '--version', action='version',
+                        version=f'%(prog)s {__version__}')
+    parser.add_argument('path', nargs='+',
+                        help='.tex files, globs or directories to build')
+
+    args = parser.parse_args()
+
+    failed = []
+    for path in resolve(args.path):
+        print(f'==> {path}', flush=True)
+
+        # One unbuildable document must not strand the rest of the batch,
+        # so collect the failures and report them together at the end.
+        try:
+            build_pdf(path)
+
+            if args.sol:
+                build_pdf(path, jobname=f'{path.stem}_sol', sol=True)
+
+            if args.rub:
+                build_pdf(path, jobname=f'{path.stem}_rub', sol=True,
+                          rub=True)
+
+            if args.pts:
+                sum_points(path)
+        except subprocess.CalledProcessError:
+            failed.append(path)
+
+    if failed:
+        names = ', '.join(str(path) for path in failed)
+        sys.exit(f'failed: {names}\nthe .log beside each holds the error')
+
+
+if __name__ == "__main__":
+    main()

solrub-0.1.0/solrub/__main__.py

@@ -0,0 +1,5 @@
+"""Entry point for python -m solrub."""
+
+from solrub import main
+
+main()

solrub-0.1.0/solrub.egg-info/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.4
+Name: solrub
+Version: 0.1.0
+Summary: Build the student, solution and rubric PDFs of a LaTeX assignment.
+Author-email: higger <matt.higger@gmail.com>
+License-Expression: MIT
+Keywords: latex,pdflatex,teaching,exam,rubric,grading
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Education
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Education
+Classifier: Topic :: Text Processing :: Markup :: LaTeX
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: pts
+Requires-Dist: sum-pts>=0.0.4; extra == "pts"
+Dynamic: license-file
+
+# solrub
+
+Build the student, solution and rubric PDFs of a LaTeX assignment.
+
+One `.tex` source carries all three copies.  `\sol` marks what only the
+answer key shows and `\rub` what only the grading rubric shows; each copy is
+a `pdflatex` run defining a different subset of them.
+
+```bash
+pip install solrub
+```
+
+## Use
+
+```bash
+solrub quiz1a              # quiz1a.pdf, quiz1a_sol.pdf, quiz1a_rub.pdf
+solrub quiz1*              # every version at once
+solrub quiz1/              # every document in a folder
+solrub --no-sol --no-rub blank
+```
+
+All three copies are the default; `--no-sol` and `--no-rub` opt out.  Add
+`-p` to sum the points (needs `pip install "solrub[pts]"`).
+
+Arguments are files, globs or directories, with the `.tex` suffix optional.
+Globs are expanded by the tool rather than left to the shell, so `quiz1*`
+works the same on Windows.  Two filters keep a wide pattern honest: sibling
+builds (`quiz1a.pdf`, `quiz1a_sol.pdf`) collapse onto the `.tex` they came
+from, and a fragment with no `\documentclass` is skipped.  A failed document
+does not stop the rest of the batch; the failures are listed at the end.
+
+## In the document
+
+Three macros divide the source.  `\answer` and `\rubric` are hidden by
+default and revealed by their build; `\exam` is the reverse, student-only
+content such as the blank space left for the work, dropped from both keys.
+
+```latex
+\newcommand{\answer}[1]{}
+\newcommand{\rubric}[1]{}
+\newcommand{\exam}[1]{#1}
+
+\ifdefined\sol
+  \renewcommand{\answer}[1]{#1}
+  \renewcommand{\exam}[1]{}
+\fi
+
+\ifdefined\rub
+  \renewcommand{\rubric}[1]{#1}
+  \renewcommand{\exam}[1]{}
+\fi
+```
+
+## Requires
+
+`pdflatex` on the PATH, and Python 3.9 or newer.

solrub-0.1.0/solrub.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+solrub/__init__.py
+solrub/__main__.py
+solrub.egg-info/PKG-INFO
+solrub.egg-info/SOURCES.txt
+solrub.egg-info/dependency_links.txt
+solrub.egg-info/entry_points.txt
+solrub.egg-info/requires.txt
+solrub.egg-info/top_level.txt

solrub-0.1.0/solrub.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

solrub-0.1.0/solrub.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+solrub = solrub:main

solrub-0.1.0/solrub.egg-info/requires.txt

@@ -0,0 +1,3 @@
+
+[pts]
+sum-pts>=0.0.4

solrub-0.1.0/solrub.egg-info/top_level.txt

@@ -0,0 +1 @@
+solrub