pystatsv1 0.22.2__py3-none-any.whl

pystatsv1/__init__.py

@@ -0,0 +1,36 @@
+"""
+Top-level package for the PyStatsV1 project.
+
+Convenience re-exports:
+
+- DATA_DIR, SYNTHETIC_DATA_DIR
+- OUTPUTS_DIR, TRACK_C_OUTPUT_DIR
+- PROJECT_ROOT
+"""
+
+from importlib.metadata import PackageNotFoundError, version
+from .docs_helper import get_local_docs_path, open_local_docs
+
+from .paths import (  # noqa: F401
+    DATA_DIR,
+    SYNTHETIC_DATA_DIR,
+    OUTPUTS_DIR,
+    TRACK_C_OUTPUT_DIR,
+    PROJECT_ROOT,
+)
+
+__all__ = [
+    "DATA_DIR",
+    "SYNTHETIC_DATA_DIR",
+    "OUTPUTS_DIR",
+    "TRACK_C_OUTPUT_DIR",
+    "PROJECT_ROOT",
+    "__version__",
+    "get_local_docs_path",
+    "open_local_docs",
+]
+
+try:
+    __version__ = version("pystatsv1")
+except PackageNotFoundError:  # pragma: no cover
+    __version__ = "0.0.0"

pystatsv1/__main__.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+from .cli import main
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

pystatsv1/assets/__init__.py

@@ -0,0 +1 @@
+"""Packaged assets used by CLI helpers (workbook starter kit, etc.)."""

pystatsv1/cli.py

@@ -0,0 +1,501 @@
+from __future__ import annotations
+
+import argparse
+import os
+import platform
+import re
+import subprocess
+import sys
+import textwrap
+import zipfile
+from importlib import metadata, resources
+from pathlib import Path
+from typing import Final
+
+
+PKG: Final[str] = "pystatsv1"
+
+
+def _in_venv() -> bool:
+    # Works for venv and virtualenv.
+    return getattr(sys, "base_prefix", sys.prefix) != sys.prefix
+
+
+def _open_file(path: Path) -> None:
+    # Cross-platform "open in default app"
+    if sys.platform.startswith("win"):
+        os.startfile(str(path))  # type: ignore[attr-defined]
+        return
+    if sys.platform == "darwin":
+        os.execvp("open", ["open", str(path)])
+    else:
+        os.execvp("xdg-open", ["xdg-open", str(path)])
+
+
+def _get_packaged_pdf() -> Path | None:
+    # Packaged as pystatsv1/docs/pystatsv1.pdf
+    try:
+        candidate = resources.files(PKG) / "docs" / "pystatsv1.pdf"
+        with resources.as_file(candidate) as p:
+            return Path(p)
+    except Exception:
+        return None
+
+
+def cmd_docs(_: argparse.Namespace) -> int:
+    pdf = _get_packaged_pdf()
+    if pdf is None or not pdf.exists():
+        print("Local docs PDF not found in this installation.")
+        return 1
+
+    print(f"Opening: {pdf}")
+    _open_file(pdf)
+    return 0
+
+
+def _normalize_track(track: str | None) -> str:
+    t = (track or "c").strip().lower()
+    if t in {"c", "track_c"}:
+        return "c"
+    if t in {"d", "track_d"}:
+        return "d"
+    raise SystemExit(
+        "Unknown track. Use one of: c, track_c, d, track_d.\n"
+        "Example: pystatsv1 workbook init --track d"
+    )
+
+
+def _workbook_asset_for_track(track: str) -> str:
+    t = _normalize_track(track)
+    return {
+        "c": "workbook_starter.zip",
+        "d": "workbook_track_d.zip",
+    }[t]
+
+
+def _extract_workbook_template(dest: Path, force: bool, track: str = "c") -> None:
+    dest = dest.expanduser().resolve()
+
+    if dest.exists():
+        if any(dest.iterdir()) and not force:
+            raise SystemExit(
+                f"Refusing to write into non-empty directory: {dest}\n"
+                "Use --force to overwrite into an existing directory."
+            )
+    else:
+        dest.mkdir(parents=True, exist_ok=True)
+
+    asset_name = _workbook_asset_for_track(track)
+    asset = resources.files(f"{PKG}.assets") / asset_name
+    with resources.as_file(asset) as asset_path:
+        with zipfile.ZipFile(asset_path) as zf:
+            zf.extractall(dest)
+
+
+def _extract_asset_zip(asset_name: str, dest: Path) -> None:
+    asset = resources.files(f"{PKG}.assets") / asset_name
+    with resources.as_file(asset) as asset_path:
+        with zipfile.ZipFile(asset_path) as zf:
+            zf.extractall(dest)
+
+
+def _extract_track_d_datasets(dest: Path) -> None:
+    # Extract canonical Track D datasets (seed=123) into the workbook folder.
+    ds_root = dest / "data" / "synthetic"
+    ds_root.mkdir(parents=True, exist_ok=True)
+
+    for asset_name in (
+        "ledgerlab_ch01_seed123.zip",
+        "nso_v1_seed123.zip",
+    ):
+        try:
+            _extract_asset_zip(asset_name, ds_root)
+        except Exception as e:
+            raise SystemExit(
+                "Failed to extract Track D canonical datasets. "
+                "Try upgrading PyStatsV1 (pip install -U pystatsv1) and re-run workbook init. "
+                f"Missing or unreadable asset: {asset_name}"
+            ) from e
+
+
+def cmd_workbook_init(args: argparse.Namespace) -> int:
+    track = _normalize_track(getattr(args, "track", "c"))
+    _extract_workbook_template(Path(args.dest), force=args.force, track=track)
+
+    dest = Path(args.dest).expanduser().resolve()
+    if track == "d":
+        _extract_track_d_datasets(dest)
+        next_steps = textwrap.dedent(
+            f"""\
+            ✅ Track D workbook starter created at:
+
+                {dest}
+
+            Next steps:
+              1) cd {dest}
+              2) pystatsv1 workbook run d00_peek_data
+
+            (Datasets are pre-installed under data/synthetic/, seed=123.)
+
+            Tip: If you're new to Python, always work inside a virtual environment.
+            """
+        ).rstrip()
+        print(next_steps)
+        return 0
+
+    print(
+        textwrap.dedent(
+            f"""\
+            ✅ Workbook starter created at:
+
+                {dest}
+
+            Next steps:
+              1) cd {dest}
+              2) pystatsv1 workbook run ch10
+              3) pystatsv1 workbook check ch10
+
+            Tip: If you're new to Python, always work inside a virtual environment.
+            """
+        ).rstrip()
+    )
+    return 0
+
+
+def cmd_workbook_list(args: argparse.Namespace) -> int:
+    track = _normalize_track(getattr(args, "track", "c"))
+
+    if track == "d":
+        chapters = [
+            "D00  Setup/reset Track D datasets (run: d00_setup_data)",
+            "D00  Peek the Track D datasets (LedgerLab + NSO) (run: d00_peek_data)",
+            "D01  Ch01 Accounting as a measurement system (run: d01)",
+            "D02  Ch02 Double-entry and the general ledger as a database (run: d02)",
+            "D03  Ch03 Financial statements as summaries (run: d03)",
+            "D04  Ch04 Assets: inventory + fixed assets (run: d04)",
+            "D05  Ch05 Liabilities, payroll, taxes, and equity (run: d05)",
+            "D06  Ch06 Reconciliations and quality control (run: d06)",
+            "D07  Ch07 Preparing accounting data for analysis (run: d07)",
+            "D08  Ch08 Descriptive statistics for financial performance (run: d08)",
+            "D09  Ch09 Reporting style contract (run: d09)",
+            "D10  Ch10 Probability and risk (run: d10)",
+            "D11  Ch11 Sampling, estimation, and audit controls (run: d11)",
+            "D12  Ch12 Hypothesis testing for decisions (run: d12)",
+            "D13  Ch13 Correlation, causation, and controlled comparisons (run: d13)",
+            "D14  Ch14 Regression and driver analysis (run: d14)",
+            "D15  Ch15 Forecasting foundations (run: d15)",
+            "D16  Ch16 Seasonality and baselines (run: d16)",
+            "D17  Ch17 Revenue forecasting: segmentation + drivers (run: d17)",
+            "D18  Ch18 Expense forecasting: fixed/variable/step + payroll (run: d18)",
+            "D19  Ch19 Cash flow forecasting: direct method (13-week) (run: d19)",
+            "D20  Ch20 Integrated forecasting: three statements (run: d20)",
+            "D21  Ch21 Scenario planning: sensitivity + stress (run: d21)",
+            "D22  Ch22 Financial statement analysis toolkit (run: d22)",
+            "D23  Ch23 Communicating results and governance (run: d23)",
+        ]
+        print("\n".join(chapters))
+        return 0
+
+    # Track C (default): bundled in the starter zip.
+    chapters = [
+        "Ch10  One-way ANOVA",
+        "Ch11  Repeated measures / mixed designs (problem set)",
+        "Ch12  Factorial designs",
+        "Ch14  Nonparametric tests",
+        "Ch15  Correlation & simple regression",
+        "Ch16  Multiple regression",
+        "Ch17  Logistic regression",
+        "Ch18  ANCOVA",
+        "Ch19  Mediation / moderation (intro)",
+        "Ch20  Power / simulation (intro)",
+    ]
+    print("\n".join(chapters))
+    return 0
+
+
+def _dist_version(dist_name: str) -> str:
+    try:
+        return metadata.version(dist_name)
+    except metadata.PackageNotFoundError:
+        return "not installed"
+    except Exception:
+        return "unknown"
+
+
+
+def _workdir(args: argparse.Namespace) -> Path:
+    return Path(getattr(args, "workdir", ".")).expanduser().resolve()
+
+
+_CHAPTER_RE: Final[re.Pattern[str]] = re.compile(r"^ch(?P<num>\d+)$", re.IGNORECASE)
+
+
+def _chapter_num(key: str) -> int | None:
+    m = _CHAPTER_RE.match(key.strip())
+    if not m:
+        return None
+    return int(m.group("num"))
+
+
+def _resolve_script_path(workdir: Path, target: str) -> Path:
+    target = target.strip()
+
+    # Explicit path?
+    if target.endswith(".py") or "/" in target or "\\" in target:
+        p = Path(target)
+        if not p.is_absolute():
+            p = workdir / p
+        return p
+
+    ch = _chapter_num(target)
+    if ch is not None:
+        return workdir / "scripts" / f"psych_ch{ch:02d}_problem_set.py"
+
+    # Default: treat as a script key under scripts/
+    return workdir / "scripts" / f"{target}.py"
+
+
+def _resolve_test_path(workdir: Path, target: str) -> Path:
+    target = target.strip()
+
+    ch = _chapter_num(target)
+    if ch is not None:
+        return workdir / "tests" / f"test_psych_ch{ch:02d}_problem_set.py"
+
+    # Try a few conventions for non-chapter keys.
+    candidates = [
+        workdir / "tests" / f"test_{target}.py",
+        workdir / "tests" / f"test_{target}_case_study.py",
+        workdir / "tests" / f"test_{target}_problem_set.py",
+    ]
+    for c in candidates:
+        if c.exists():
+            return c
+    # If none exist, still return the first candidate for a helpful error path.
+    return candidates[0]
+
+
+def cmd_workbook_run(args: argparse.Namespace) -> int:
+    workdir = _workdir(args)
+    script = _resolve_script_path(workdir, args.target)
+
+    if not script.exists():
+        print(
+            "❌ Could not find the script to run.\n"
+            f"   Looking for: {script}\n\n"
+            "Tip: run this inside your workbook folder (created by `pystatsv1 workbook init`).\n"
+            "     Or pass --workdir to point at it."
+        )
+        return 2
+
+    # Ensure workbook-root imports like `import scripts.foo` work reliably.
+    # Many workbook scripts use `from scripts...` imports; adding the workbook
+    # directory to PYTHONPATH makes this consistent across platforms.
+    env = os.environ.copy()
+    existing = env.get("PYTHONPATH", "")
+    prefix = str(workdir)
+    env["PYTHONPATH"] = (
+        f"{prefix}{os.pathsep}{existing}" if existing else prefix
+    )
+
+    cmd = [sys.executable, str(script)]
+    try:
+        subprocess.run(cmd, cwd=str(workdir), env=env, check=True)
+    except subprocess.CalledProcessError as e:
+        return int(e.returncode or 1)
+    return 0
+
+
+def cmd_workbook_check(args: argparse.Namespace) -> int:
+    workdir = _workdir(args)
+    test_file = _resolve_test_path(workdir, args.target)
+
+    if not test_file.exists():
+        print(
+            "❌ Could not find the test file to run.\n"
+            f"   Looking for: {test_file}\n\n"
+            "Tip: run this inside your workbook folder (created by `pystatsv1 workbook init`).\n"
+            "     Or pass --workdir to point at it."
+        )
+        return 2
+
+    # Match `workbook run`: keep workbook-root import resolution consistent.
+    env = os.environ.copy()
+    existing = env.get("PYTHONPATH", "")
+    prefix = str(workdir)
+    env["PYTHONPATH"] = f"{prefix}{os.pathsep}{existing}" if existing else prefix
+
+    cmd = [sys.executable, "-m", "pytest", "-q", str(test_file)]
+    try:
+        subprocess.run(cmd, cwd=str(workdir), env=env, check=True)
+    except subprocess.CalledProcessError as e:
+        return int(e.returncode or 1)
+    return 0
+
+_REQUIRED_IMPORTS: Final[list[tuple[str, str]]] = [
+    ("numpy", "numpy"),
+    ("pandas", "pandas"),
+    ("scipy", "scipy"),
+    ("statsmodels", "statsmodels"),
+    ("matplotlib", "matplotlib"),
+    ("pingouin", "pingouin"),
+    ("sklearn", "scikit-learn"),
+]
+
+
+def cmd_doctor(args: argparse.Namespace) -> int:
+    ok = True
+
+    in_venv = _in_venv()
+    if not in_venv:
+        print(
+            "⚠️  You are NOT in a virtual environment. This is OK, but not recommended.\n"
+            "Create one and activate it first:\n"
+            "  python -m venv .venv\n"
+            "  source .venv/Scripts/activate   # Windows Git Bash\n"
+            "  source .venv/bin/activate       # macOS/Linux\n"
+        )
+
+    if getattr(args, "verbose", False):
+        print("Environment")
+        print(f"  python: {sys.version.splitlines()[0]}")
+        print(f"  executable: {sys.executable}")
+        print(f"  platform: {platform.platform()}")
+        print(f"  venv: {'yes' if in_venv else 'no'}")
+        print("\nPackages")
+
+    missing: list[str] = []
+
+    # Lightweight import checks (avoid crashing if optional deps are missing)
+    for mod, dist in _REQUIRED_IMPORTS:
+        try:
+            __import__(mod)
+        except Exception:
+            missing.append(mod)
+
+        if getattr(args, "verbose", False):
+            print(f"  - {mod}: {_dist_version(dist)}")
+
+    if missing:
+        ok = False
+        print(
+            "\n❌ Missing packages in this environment:\n  - "
+            + "\n  - ".join(missing)
+            + "\n\nInstall the student bundle:\n"
+            "  python -m pip install -U pip\n"
+            "  python -m pip install \"pystatsv1[workbook]\"\n"
+        )
+
+    if ok:
+        if in_venv:
+            print("✅ Environment looks good.")
+        else:
+            print("✅ Packages look good (consider using a venv).")
+        return 0
+
+    return 1
+
+
+def build_parser() -> argparse.ArgumentParser:
+    p = argparse.ArgumentParser(
+        prog="pystatsv1",
+        description="PyStatsV1: treat statistical analysis like production software.",
+    )
+    p.add_argument(
+        "--version",
+        action="version",
+        version=_version_string(),
+    )
+
+    sub = p.add_subparsers(dest="cmd", required=True)
+
+    p_docs = sub.add_parser("docs", help="Open packaged PDF docs (if available).")
+    p_docs.set_defaults(func=cmd_docs)
+
+    p_doctor = sub.add_parser("doctor", help="Sanity-check your environment (venv + deps).")
+    p_doctor.add_argument(
+        "--verbose",
+        action="store_true",
+        help="Print Python/platform info and package versions.",
+    )
+    p_doctor.set_defaults(func=cmd_doctor)
+
+    p_wb = sub.add_parser("workbook", help="Workbook helpers (student labs).")
+    wb_sub = p_wb.add_subparsers(dest="workbook_cmd", required=True)
+
+    p_init = wb_sub.add_parser("init", help="Create a local workbook starter folder.")
+    p_init.add_argument(
+        "--track",
+        default="c",
+        help="Which workbook to create: c (intro/psych) or d (business case). Default: c.",
+    )
+    p_init.add_argument(
+        "--dest",
+        default="pystatsv1_workbook",
+        help="Destination directory to create (default: pystatsv1_workbook).",
+    )
+    p_init.add_argument(
+        "--force",
+        action="store_true",
+        help="Allow writing into an existing non-empty directory.",
+    )
+    p_init.set_defaults(func=cmd_workbook_init)
+
+    p_list = wb_sub.add_parser("list", help="List chapters included in a starter kit.")
+    p_list.add_argument(
+        "--track",
+        default="c",
+        help="Which chapter list to show: c (intro/psych) or d (business case). Default: c.",
+    )
+    p_list.set_defaults(func=cmd_workbook_list)
+
+    p_run = wb_sub.add_parser("run", help="Run a workbook script (no make required).")
+    p_run.add_argument(
+        "target",
+        help="Target to run: chapter key like 'ch10', a script key like 'study_habits_01_explore', or a .py path.",
+    )
+    p_run.add_argument(
+        "--workdir",
+        default=".",
+        help="Workbook directory (default: current directory).",
+    )
+    p_run.set_defaults(func=cmd_workbook_run)
+
+    p_check = wb_sub.add_parser("check", help="Run workbook checks/tests via pytest (no make required).")
+    p_check.add_argument(
+        "target",
+        help="Target to check: chapter key like 'ch10' or a key that resolves to tests/test_<key>*.py.",
+    )
+    p_check.add_argument(
+        "--workdir",
+        default=".",
+        help="Workbook directory (default: current directory).",
+    )
+    p_check.set_defaults(func=cmd_workbook_check)
+
+
+    return p
+
+
+def _version_string() -> str:
+    try:
+        from importlib.metadata import version
+
+        return version(PKG)
+    except Exception:
+        return "unknown"
+
+
+def main(argv: list[str] | None = None) -> int:
+    parser = build_parser()
+    args = parser.parse_args(argv)
+    return int(args.func(args))
+
+
+# Back-compat: allow a dedicated console script for docs if desired.
+def docs_main(argv: list[str] | None = None) -> int:
+    return main(["docs"] + ([] if argv is None else argv))
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

pystatsv1/docs_helper.py

@@ -0,0 +1,29 @@
+from __future__ import annotations
+
+import os
+import sys
+from pathlib import Path
+
+
+def get_local_docs_path() -> Path:
+    """Return the absolute path to the packaged PDF (pystatsv1/docs/pystatsv1.pdf)."""
+    # Resolve relative to this module, which is stable in editable installs and wheels.
+    pkg_dir = Path(__file__).resolve().parent
+    pdf = pkg_dir / "docs" / "pystatsv1.pdf"
+    return pdf
+
+
+def open_local_docs() -> Path:
+    """Open the packaged PDF in the system default viewer and return the path."""
+    pdf = get_local_docs_path()
+    if not pdf.exists():
+        raise FileNotFoundError(f"Local docs PDF not found: {pdf}")
+
+    if sys.platform.startswith("win"):
+        os.startfile(str(pdf))  # type: ignore[attr-defined]
+    elif sys.platform == "darwin":
+        os.system(f'open "{pdf}"')
+    else:
+        os.system(f'xdg-open "{pdf}"')
+
+    return pdf

pystatsv1/paths.py

@@ -0,0 +1,44 @@
+"""
+Centralized filesystem paths for the PyStatsV1 project.
+
+Repo layout:
+
+    PyStatsV1/
+      data/
+        synthetic/
+      outputs/
+        track_c/
+      docs/
+      scripts/
+      src/pystatsv1/...
+
+This module exposes a small set of reusable Path objects so scripts and
+tests don't have to duplicate logic for finding the project root.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+# src/pystatsv1/paths.py -> .../src/pystatsv1 -> .../src -> .../PyStatsV1
+PACKAGE_ROOT = Path(__file__).resolve().parent
+PROJECT_ROOT = PACKAGE_ROOT.parents[1]
+
+# Data directories
+DATA_DIR = PROJECT_ROOT / "data"
+SYNTHETIC_DATA_DIR = DATA_DIR / "synthetic"
+
+# Outputs (top-level and Track C specific)
+OUTPUTS_DIR = PROJECT_ROOT / "outputs"
+TRACK_C_OUTPUT_DIR = OUTPUTS_DIR / "track_c"
+
+
+def ensure_dir(path: Path) -> Path:
+    """Ensure that ``path`` exists (mkdir -p) and return it."""
+    path.mkdir(parents=True, exist_ok=True)
+    return path
+
+
+def ensure_output_subdir(name: str) -> Path:
+    """Ensure that a subdirectory of OUTPUTS_DIR exists and return it."""
+    return ensure_dir(OUTPUTS_DIR / name)

pystatsv1-0.22.2.dist-info/METADATA

@@ -0,0 +1,329 @@
+Metadata-Version: 2.4
+Name: pystatsv1
+Version: 0.22.2
+Summary: PyStatsV1: applied statistics labs in Python.
+Author: PyStatsV1 contributors
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/pystatsv1/PyStatsV1
+Project-URL: Documentation, https://pystatsv1.readthedocs.io
+Project-URL: Source, https://github.com/pystatsv1/PyStatsV1
+Project-URL: Issues, https://github.com/pystatsv1/PyStatsV1/issues
+Project-URL: PyPI, https://pypi.org/project/pystatsv1/
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.24
+Requires-Dist: pandas>=2.0
+Requires-Dist: scipy>=1.10
+Requires-Dist: statsmodels>=0.14
+Requires-Dist: matplotlib>=3.8
+Requires-Dist: pingouin>=0.5
+Requires-Dist: scikit-learn>=1.3
+Provides-Extra: workbook
+Requires-Dist: pytest>=8.2; extra == "workbook"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.2; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: black>=24.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=8.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=2.0; extra == "docs"
+Requires-Dist: myst-parser>=3.0; extra == "docs"
+Dynamic: license-file
+
+# PyStatsV1 — Applied Statistics (R ↔ Python)
+
+[![CI](https://img.shields.io/github/actions/workflow/status/pystatsv1/PyStatsV1/ci.yml?branch=main&label=ci&color=brightgreen)](https://github.com/pystatsv1/PyStatsV1/actions/workflows/ci.yml)
+[![GitHub release](https://img.shields.io/github/v/tag/pystatsv1/PyStatsV1?label=release&color=brightgreen)](https://github.com/pystatsv1/PyStatsV1/tags)
+[![Docs](https://readthedocs.org/projects/pystatsv1/badge/?version=latest)](https://pystatsv1.readthedocs.io/en/latest/?badge=latest)
+[![PyPI - Version](https://img.shields.io/pypi/v/pystatsv1.svg?label=pypi&color=brightgreen)](https://pypi.org/project/pystatsv1/)
+[![Python version](https://img.shields.io/badge/python-3.10%2B-brightgreen)](https://pypi.org/project/pystatsv1/)
+
+PyStatsV1 provides **plain, transparent Python scripts** that mirror classical **R textbook analyses**, making it easy for students, tutors, and practitioners to:
+
+- run statistical analyses from the command line,
+- generate synthetic data for teaching,
+- produce figures and JSON summaries,
+- and compare outputs across R/Python.
+
+## ⭐ Fastest start (PyPI + Workbook)
+
+Install from PyPI (recommended: include the Workbook bundle so you can run `pytest` checks):
+
+```bash
+python -m pip install -U pip
+python -m pip install "pystatsv1[workbook]"
+```
+
+Sanity-check your environment:
+
+```bash
+pystatsv1 doctor
+```
+
+Create a local Workbook starter and run Chapter 10:
+
+```bash
+pystatsv1 workbook init
+cd pystatsv1_workbook
+
+python scripts/psych_ch10_problem_set.py
+pytest -q
+```
+
+Open the bundled local PDF docs (works offline):
+
+```bash
+pystatsv1 docs
+# optional convenience script:
+pystatsv1-docs
+```
+
+Tip: the online docs are always available via the ReadTheDocs badge at the top of this README.
+
+## Full repository (scripts, Makefile targets, tests, docs)
+
+
+If you want the full chapter-by-chapter repo (simulators, analyzers, Makefile targets, tests, and the docs source), clone from GitHub and install in editable mode:
+
+```bash
+git clone https://github.com/pystatsv1/PyStatsV1.git
+cd PyStatsV1
+pip install -e .
+pip install -r requirements-dev.txt
+```
+
+## Project Structure
+
+The project follows a **chapter-based structure** — each chapter includes a simulator, an analyzer, Makefile targets, and CI smoke tests.
+
+### Who is this for?
+
+PyStatsV1 is designed for:
+
+- **Students** who want to run textbook-style analyses in real Python code.
+- **Instructors / TAs** who need reproducible demos and synthetic data for lectures, labs, or assignments.
+- **Practitioners** who prefer plain scripts and command-line tools over large frameworks.
+- **R users** who want a clear, line-by-line bridge from R examples into Python.
+
+---
+
+## 🚀 Using a Virtual Environment
+
+### Option A — Student mode (PyPI + Workbook)
+
+**macOS / Linux**
+
+```bash
+python -m venv pystatsv1-env
+source pystatsv1-env/bin/activate
+python -m pip install -U pip
+python -m pip install "pystatsv1[workbook]"
+pystatsv1 doctor
+pystatsv1 workbook init
+```
+
+**Windows (Git Bash)**
+
+```bash
+python -m venv pystatsv1-env
+source pystatsv1-env/Scripts/activate
+python -m pip install -U pip
+python -m pip install "pystatsv1[workbook]"
+pystatsv1 doctor
+pystatsv1 workbook init
+```
+
+### Option B — Repo dev install (contributors)
+
+```bash
+python -m venv .venv
+# Git Bash first; PowerShell as fallback
+source .venv/Scripts/activate 2>/dev/null || .venv\\Scripts\\Activate.ps1
+python -m pip install -U pip
+pip install -e .
+pip install -r requirements-dev.txt
+```
+
+
+---
+
+## 📊 Chapter Scripts
+
+### Chapter 1 — Introduction
+
+```bash
+python -m scripts.ch01_introduction
+```
+
+### Chapter 13 — Within-subjects & Mixed Models
+
+```bash
+make ch13-ci   # tiny CI smoke
+make ch13      # full demo
+```
+
+### Chapter 14 — Tutoring A/B Test (two-sample t-test)
+
+```bash
+make ch14-ci
+make ch14
+```
+
+### Chapter 15 — Reliability (Cronbach’s α, ICC, Bland–Altman)
+
+```bash
+make ch15-ci
+make ch15
+```
+
+For an overview of what each chapter contains:
+
+- **[CHAPTERS.md](CHAPTERS.md)** — coverage, commands, and outputs
+- **[ROADMAP.md](ROADMAP.md)** — planned chapters (e.g., Ch16 Epidemiology RR)
+
+---
+
+## 📚 Project Docs & Policies
+
+PyStatsV1 is structured with a core set of documentation:
+
+- **[CONTRIBUTING.md](CONTRIBUTING.md)** — environment setup, development workflow, Makefile usage, PR process.
+- **[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)** — community expectations & enforcement.
+- **[CHAPTERS.md](CHAPTERS.md)** — high-level description of all implemented chapters.
+- **[ROADMAP.md](ROADMAP.md)** — the future of the project: upcoming chapters & milestones.
+- **[SECURITY.md](SECURITY.md)** — how to privately report vulnerabilities.
+- **[SUPPORT.md](SUPPORT.md)** — how to get help or ask questions.
+- **Case Study Template:** [`docs/case_study_template.md`](docs/case_study_template.md) — structure for building new chapter teaching documentation.
+
+If you want to contribute, start with **[CONTRIBUTING.md](CONTRIBUTING.md)** and check issues labeled
+`good first issue` or `help wanted`.
+
+---
+
+## 🤝 Contribute in 5 minutes
+
+Want to help but not sure where to start?
+
+1. **Browse issues** labeled `good first issue` or `help wanted`.
+2. **Pick one small thing** (typo, doc improvement, tiny refactor, or a missing test).
+3. **Fork & clone** the repo.
+4. **Create and activate a virtual environment**, then:
+
+   ```bash
+   pip install -r requirements.txt
+   make lint
+   make test
+   ```
+
+5. Make your change, and ensure `make lint` and `make test` both pass.
+6. Open a Pull Request and briefly describe:
+   - what you changed,
+   - how you tested it,
+   - which chapter(s) it touches, if any.
+
+Maintainer promise: we’ll give constructive feedback and help first-time contributors land their PRs.
+
+---
+
+## 🗺️ Roadmap snapshot
+
+High-level upcoming work (see `ROADMAP.md` for details):
+
+- ✅ v0.17.0 — Onboarding and issue templates
+- ⏳ Next steps:
+  - Additional regression chapters (logistic, Poisson, etc.)
+  - Power and sample size simulations
+  - Epidemiology-focused examples (risk ratios, odds ratios)
+  - More teaching case studies using `docs/case_study_template.md`
+
+If you’d like to champion a specific chapter or topic, open an issue and we can design it together.
+
+---
+
+## 🧪 Development Workflow
+
+From the project root:
+
+```bash
+make lint    # ruff check
+make test    # pytest
+```
+
+To run chapter smoke tests:
+
+```bash
+make ch13-ci
+make ch14-ci
+make ch15-ci
+```
+
+All synthetic data is written to:
+
+- `data/synthetic/`
+- `outputs/<chapter>/`
+
+…and ignored by Git.
+
+---
+
+## 🔀 Pull Requests
+
+Every pull request should:
+
+- pass `make lint` and `make test`,
+- avoid committing generated outputs,
+- follow the structure described in **[CONTRIBUTING.md](CONTRIBUTING.md)**.
+
+GitHub provides:
+
+- 🐛 Bug report template
+- 💡 Feature request template
+- 📘 Good first issue template
+- 🔀 Pull request template
+
+---
+
+## 🔒 Security
+
+If you believe you’ve found a security issue, **do not** open a public GitHub issue.  
+Follow the private disclosure process described in **[SECURITY.md](SECURITY.md)**.
+
+---
+
+## 💬 Community & support
+
+- **Questions?**  
+  Open a GitHub issue with the `question` label.
+
+- **Using PyStatsV1 in a course?**  
+  We’d love to hear about it — open an issue titled `Course report: <institution>` or mention it in your PR description.
+
+- **Feature ideas / chapter requests?**  
+  Open an issue with the `enhancement` or `chapter-idea` label.
+
+As the project grows, we plan to enable GitHub Discussions and possibly a lightweight chat space for instructors and contributors.
+
+---
+
+
+```bash
+python -m pip install --upgrade pip
+python -m pip install "pystatsv1[workbook]"
+```
+
+```bash
+pystatsv1 workbook init --dest pystatsv1_workbook
+pystatsv1 workbook run ch10 --workdir pystatsv1_workbook
+pystatsv1 workbook check ch10 --workdir pystatsv1_workbook
+```
+
+Notes:
+
+- **No `make` required.** The workbook commands work on Linux, macOS, and Windows.
+- ``workbook check`` runs `pytest` (installed via the ``[workbook]`` extra).
+- If you prefer, you can also run the chapter scripts directly under ``pystatsv1_workbook/scripts/``.
+
+## 📜 License
+
+MIT © 2025 Nicholas Elliott Karlson

pystatsv1-0.22.2.dist-info/RECORD

@@ -0,0 +1,17 @@
+pystatsv1/__init__.py,sha256=2nPxK5aAN43oTCO3iToQpuuxwvy8pcuMBfHsnSZYcNw,729
+pystatsv1/__main__.py,sha256=nbdP6zFlOqcCirgxoIQ6HiWVhdh7URm5GOWr5_EwmBk,116
+pystatsv1/cli.py,sha256=M4dKCUSOKfpGylyaQC4SQZkIBNsxDXgSzfGxak7eoKE,16163
+pystatsv1/docs_helper.py,sha256=4IAMAofXhl3B2MsODVp9G8RX67PBDZUMx7UwJ7uGMsE,876
+pystatsv1/paths.py,sha256=_N5OxNsHewnpSOgoGMXoW7y0eXwOcQ_OJMyRef9OswI,1120
+pystatsv1/assets/__init__.py,sha256=hlrAbVFNOYExBWItzCFI5hLJzmP8jJ9xiCXWNyXz2Ss,72
+pystatsv1/assets/ledgerlab_ch01_seed123.zip,sha256=2Cr1UF1sR-aCVbuS8tk5x9_NmSS41zz_lqzMdX9-3rk,4442
+pystatsv1/assets/nso_v1_seed123.zip,sha256=V2DshRrJLyB_fuk8i7aGHmj4KSWViZlHmFigI7HysMA,80958
+pystatsv1/assets/workbook_starter.zip,sha256=XYw3HAMPGuNB9sVcXcvOkpRYX5szQFX1Orak__q3KvY,58136
+pystatsv1/assets/workbook_track_d.zip,sha256=qEvS2UN8Ey7519jUASlIXkBiMsw1OH-txQJs-Et2qw8,167899
+pystatsv1/docs/pystatsv1.pdf,sha256=lAWTa9_pfJKpsAqgWlQa2qXI6flCHmKfRwOsQSiVges,1180298
+pystatsv1-0.22.2.dist-info/licenses/LICENSE,sha256=y1zqwmZEm_3E_rohXFs5EwIIB6uvAUB_KcVPFuK4j3U,1120
+pystatsv1-0.22.2.dist-info/METADATA,sha256=P2pCTXpAAOSbzlhDn8D9-wuZCzfRwhDNnXLiavct5uk,9390
+pystatsv1-0.22.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pystatsv1-0.22.2.dist-info/entry_points.txt,sha256=9OWdAl4LypAo03or1aO6ZOJXZkLhpRIaXsL0o9yWxvw,90
+pystatsv1-0.22.2.dist-info/top_level.txt,sha256=WlU1GU7q1JZyOlQv8NS3ciIhsZUL3A55MZkZS7WAnG8,10
+pystatsv1-0.22.2.dist-info/RECORD,,

pystatsv1-0.22.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pystatsv1-0.22.2.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+pystatsv1 = pystatsv1.cli:main
+pystatsv1-docs = pystatsv1.cli:docs_main

pystatsv1-0.22.2.dist-info/licenses/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 Nicholas Elliott Karlson
+
+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 (including the next
+paragraph) 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.

pystatsv1-0.22.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+pystatsv1