collegeplan 0.1.0__tar.gz

collegeplan-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - run: pip install -e ".[dev]"
+      - run: ruff check src/ tests/
+      - run: ruff format --check src/ tests/
+      - run: mypy src/collegeplan/
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install -e ".[dev]"
+      - run: pytest --cov=collegeplan --cov-report=xml --cov-report=term-missing

collegeplan-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,39 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - run: pip install -e ".[docs]"
+      - run: mkdocs build --strict
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

collegeplan-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - run: pip install build
+      - run: python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

collegeplan-0.1.0/.gitignore

@@ -0,0 +1,12 @@
+__pycache__/
+*.pyc
+*.egg-info/
+.venv/
+.coverage
+.pytest_cache/
+dist/
+build/
+.mypy_cache/
+.ruff_cache/
+.DS_Store
+site/

collegeplan-0.1.0/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2025-03-18
+
+### Added
+
+- Year-by-year college cost projection engine in nominal dollars.
+- Single-child projection via `project_child_plan()`.
+- Multi-child household projection with shared funding pool via `project_household_plan()`.
+- Bisection solver to find required annual savings via `solve_required_savings()`.
+- Sensitivity sweep across assumption grids via `run_sensitivity()`.
+- Three built-in cost profiles: private school, public in-state, public out-of-state.
+- Age-based glide path support with Vanguard Target Enrollment preset.
+- Shared fund allocation policies: EQUAL_SPLIT, OLDEST_FIRST, PROPORTIONAL_TO_NEED.
+- Fisher equation for real/nominal return conversion via `normalize_assumptions()`.
+- `deflate()` helper for converting nominal projections to today's dollars.
+- JSON and dict serialization via `to_dict()` and `to_json()`.
+- Comprehensive input validation with descriptive error messages.
+- Frozen dataclass models with `slots=True` for all domain objects.
+- PEP 561 `py.typed` marker for type checker support.
+- Full test suite (63 tests) with strict mypy and ruff linting.
+
+[0.1.0]: https://github.com/engineerinvestor/collegeplan/releases/tag/v0.1.0

collegeplan-0.1.0/CLAUDE.md

@@ -0,0 +1,82 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## What This Is
+
+A pure-Python, zero-dependency college cost projection and savings planning engine. It projects future college costs, simulates 529/savings account growth, solves for required savings via bisection, and runs sensitivity sweeps. Designed as a standalone library that can later be embedded into the Summitward product.
+
+## Engineering Standards
+
+- Python 3.10+
+- Type hints on all functions
+- `ruff` for linting and formatting, `mypy` for type checking
+- `pytest` for testing with coverage
+- Semantic versioning (v0.1 MVP → v0.5 → v1.0)
+
+## Git Configuration
+
+- **Remote:** https://github.com/engineerinvestor/collegeplan
+- **Commit as:** Engineer Investor (`egr.investor@gmail.com`)
+- Always use `git -c user.name="Engineer Investor" -c user.email="egr.investor@gmail.com" commit` when committing
+
+## Writing Style
+
+- **No em-dashes or double-dashes.** Never use `—` or `--` as punctuation in prose, markdown, or notebooks. Use a comma, period, colon, or semicolon instead.
+
+## Commands
+
+```bash
+pip install -e ".[dev]"          # Install package + dev deps (pytest, pytest-cov, ruff, mypy)
+pytest                            # Run all tests
+pytest tests/test_engine.py       # Run one test file
+pytest -k "test_name"             # Run a single test by name
+pytest --cov=collegeplan          # Run with coverage
+ruff check src/ tests/            # Lint (must pass clean)
+ruff format --check src/ tests/   # Format check
+mypy src/collegeplan/             # Type check (strict mode, must pass clean)
+```
+
+All code must pass `ruff check` and `mypy --strict` before committing. No CI pipeline exists yet.
+
+### Ruff
+
+Configured in `pyproject.toml`. Rules: E, F, W, I (isort), UP, B (bugbear), SIM, RUF. Line length 100. Target Python 3.11. `__all__` must be sorted (RUF022). Use `ruff check --fix` for auto-fixable issues.
+
+### Mypy
+
+Configured in `pyproject.toml` with `strict = true`. Covers `src/collegeplan/` only (not tests). All public functions need type annotations. Use `Any` sparingly and only where truly needed (e.g., serialization).
+
+## Architecture
+
+The package uses a `src/` layout (`src/collegeplan/`). All domain models are **frozen dataclasses** with `slots=True, kw_only=True`. Dollar amounts are `float` internally; rounding happens only at output boundaries. Rates are decimals (0.05, not 5).
+
+### Data flow
+
+```
+Input models (Child, CostProfile, Assumptions, HouseholdFund)
+  → validators.py (raises ValidationError on bad input)
+  → assumptions.py (normalizes real/nominal returns via Fisher equation)
+  → engine.py (year-by-year simulation producing ChildProjectionResult / HouseholdProjectionResult)
+  → solver.py (bisection root-finder wrapping engine to solve for required annual savings)
+  → sensitivity.py (Cartesian product sweep over assumption grid, calls solver per scenario)
+  → reporting.py (dict/JSON serialization with dollar rounding)
+```
+
+### Key design decisions
+
+- **Annual time steps.** The engine simulates year-by-year, not monthly. Monthly savings targets are derived as `annual / 12`.
+- **Nominal dollars internally.** All projections run in nominal terms. Real-dollar conversions use `assumptions.deflate()`. The Fisher equation converts between real and nominal returns.
+- **Immutable models.** Frozen dataclasses everywhere. Modifications use `dataclasses.replace()` to create new instances.
+- **Withdrawal capping.** If a child's account can't cover a year's cost, the withdrawal is capped at available balance. The remainder becomes explicit shortfall (balances never go negative).
+- **Household projection.** Runs per-child projections first (without shared fund), then simulates the shared pool year-by-year, allocating to cover per-child shortfalls via `allocation.py` policies (EQUAL_SPLIT, OLDEST_FIRST, PROPORTIONAL_TO_NEED).
+- **Solver.** Bisection over a monotonic objective (more contribution = higher funding ratio). Upper bound is heuristically set then doubled until sufficient. Converges to $1 tolerance by default.
+- **Assumptions must provide exactly one of** `expected_return_nominal` or `expected_return_real`, not both.
+
+### Modules not yet implemented
+
+- `cli.py`: YAML plan file loader and CLI (P1 scope)
+
+## Spec Reference
+
+`SPEC.md` is the authoritative requirements document. It defines the domain model fields, validation rules (section 14), calculation framework (section 8), public API signatures (section 9), output schemas (section 10), and MVP scope (section 22, P0/P1/P2).

collegeplan-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Engineer Investor
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

collegeplan-0.1.0/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: collegeplan
+Version: 0.1.0
+Summary: A deterministic college cost projection and savings planning engine
+Project-URL: Homepage, https://engineerinvestor.github.io/collegeplan/
+Project-URL: Repository, https://github.com/engineerinvestor/collegeplan
+Project-URL: Documentation, https://engineerinvestor.github.io/collegeplan/
+Project-URL: Issues, https://github.com/engineerinvestor/collegeplan/issues
+Project-URL: Changelog, https://engineerinvestor.github.io/collegeplan/changelog/
+Author-email: Engineer Investor <egr.investor@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: 529,college,education,financial-planning,savings
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Provides-Extra: dev
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-material; extra == 'docs'
+Requires-Dist: mkdocstrings[python]; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# collegeplan
+
+[![CI](https://github.com/engineerinvestor/collegeplan/actions/workflows/ci.yml/badge.svg)](https://github.com/engineerinvestor/collegeplan/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/collegeplan)](https://pypi.org/project/collegeplan/)
+[![Python](https://img.shields.io/pypi/pyversions/collegeplan)](https://pypi.org/project/collegeplan/)
+[![License](https://img.shields.io/github/license/engineerinvestor/collegeplan)](LICENSE)
+[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://engineerinvestor.github.io/collegeplan/)
+
+A pure-Python, zero-dependency college cost projection and savings planning engine.
+
+## Install
+
+```bash
+pip install collegeplan
+```
+
+## Quick Start
+
+```python
+from collegeplan import (
+    Child, Assumptions, project_child_plan,
+    make_private_school_profile,
+)
+
+child = Child(
+    name="Alice",
+    current_age=5,
+    cost_profile=make_private_school_profile(),  # $65k, 5% growth
+    start_age=18,
+    attendance_years=4,
+    current_529_balance=25_000,
+    annual_contribution=6_000,
+)
+assumptions = Assumptions(expected_return_nominal=0.07, general_inflation=0.03)
+
+result = project_child_plan(child, assumptions)
+print(f"Total cost: ${result.projected_total_cost:,.0f}")
+print(f"Funded: {result.funded_ratio:.1%}")
+```
+
+## Documentation
+
+Full documentation is available at [engineerinvestor.github.io/collegeplan](https://engineerinvestor.github.io/collegeplan/).
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+pytest --cov=collegeplan
+ruff check src/ tests/
+mypy src/collegeplan/
+```
+
+## License
+
+Apache 2.0. See [LICENSE](LICENSE) for details.

collegeplan-0.1.0/README.md

@@ -0,0 +1,57 @@
+# collegeplan
+
+[![CI](https://github.com/engineerinvestor/collegeplan/actions/workflows/ci.yml/badge.svg)](https://github.com/engineerinvestor/collegeplan/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/collegeplan)](https://pypi.org/project/collegeplan/)
+[![Python](https://img.shields.io/pypi/pyversions/collegeplan)](https://pypi.org/project/collegeplan/)
+[![License](https://img.shields.io/github/license/engineerinvestor/collegeplan)](LICENSE)
+[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://engineerinvestor.github.io/collegeplan/)
+
+A pure-Python, zero-dependency college cost projection and savings planning engine.
+
+## Install
+
+```bash
+pip install collegeplan
+```
+
+## Quick Start
+
+```python
+from collegeplan import (
+    Child, Assumptions, project_child_plan,
+    make_private_school_profile,
+)
+
+child = Child(
+    name="Alice",
+    current_age=5,
+    cost_profile=make_private_school_profile(),  # $65k, 5% growth
+    start_age=18,
+    attendance_years=4,
+    current_529_balance=25_000,
+    annual_contribution=6_000,
+)
+assumptions = Assumptions(expected_return_nominal=0.07, general_inflation=0.03)
+
+result = project_child_plan(child, assumptions)
+print(f"Total cost: ${result.projected_total_cost:,.0f}")
+print(f"Funded: {result.funded_ratio:.1%}")
+```
+
+## Documentation
+
+Full documentation is available at [engineerinvestor.github.io/collegeplan](https://engineerinvestor.github.io/collegeplan/).
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+pytest --cov=collegeplan
+ruff check src/ tests/
+mypy src/collegeplan/
+```
+
+## License
+
+Apache 2.0. See [LICENSE](LICENSE) for details.