pystatsv1 0.18.0__py3-none-any.whl

pystatsv1/__init__.py

@@ -0,0 +1,33 @@
+"""
+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 .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__",
+]
+
+try:
+    __version__ = version("pystatsv1")
+except PackageNotFoundError:  # pragma: no cover
+    __version__ = "0.0.0"

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.18.0.dist-info/METADATA

@@ -0,0 +1,243 @@
+Metadata-Version: 2.4
+Name: pystatsv1
+Version: 0.18.0
+Summary: PyStatsV1: applied statistics labs in Python.
+Author: PyStatsV1 contributors
+License: 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.
+        
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# PyStatsV1 — Applied Statistics (R ↔ Python)
+
+[![ci](https://img.shields.io/github/actions/workflow/status/PyStatsV1/PyStatsV1/ci.yml?branch=main)](https://github.com/PyStatsV1/PyStatsV1/actions/workflows/ci.yml)
+[![release](https://img.shields.io/github/v/tag/PyStatsV1/PyStatsV1?label=release)](https://github.com/PyStatsV1/PyStatsV1/tags)
+[![Documentation Status](https://readthedocs.org/projects/pystatsv1/badge/?version=latest)](https://pystatsv1.readthedocs.io/en/latest/?badge=latest)
+
+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.
+
+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.
+
+---
+
+## 🚀 Quick Start
+
+### 1. Create and activate a virtual environment
+
+**macOS / Linux**
+
+```bash
+python -m venv .venv && source .venv/bin/activate
+python -m pip install -U pip
+pip install -r requirements.txt
+```
+
+**Windows (Git Bash or PowerShell)**
+
+```bash
+# Git Bash first; PowerShell as fallback
+python -m venv .venv; source .venv/Scripts/activate 2>/dev/null || .venv\Scripts\Activate.ps1
+python -m pip install -U pip
+pip install -r requirements.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.
+
+---
+
+## 📜 License
+
+MIT © 2025 Nicholas Elliott Karlson

pystatsv1-0.18.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+pystatsv1/__init__.py,sha256=BxGDqhAIQYH9fdNfWYUEEYe1fG8a4J3hwXiYhmtwOLk,617
+pystatsv1/paths.py,sha256=_N5OxNsHewnpSOgoGMXoW7y0eXwOcQ_OJMyRef9OswI,1120
+pystatsv1-0.18.0.dist-info/licenses/LICENSE,sha256=y1zqwmZEm_3E_rohXFs5EwIIB6uvAUB_KcVPFuK4j3U,1120
+pystatsv1-0.18.0.dist-info/METADATA,sha256=327_M-wXIOVxQngCguVrEvwCFxR1NS67ZZ9I0mbRc6o,7566
+pystatsv1-0.18.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pystatsv1-0.18.0.dist-info/top_level.txt,sha256=WlU1GU7q1JZyOlQv8NS3ciIhsZUL3A55MZkZS7WAnG8,10
+pystatsv1-0.18.0.dist-info/RECORD,,

pystatsv1-0.18.0.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.18.0.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.18.0.dist-info/top_level.txt

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