Repository navigation
[codex] repository maintenance pass - #2
Merged
Merged
Conversation
Moshbbab
marked this pull request as ready for review
June 9, 2026 13:29
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR performs a safe repository maintenance pass for
valuation-core-engineafter inspecting the codebase structure, tests, packaging metadata, documentation, generated files, and missing automation.Changes are intentionally reversible and avoid core valuation architecture changes.
What changed
CONTRIBUTING.mdwith local setup, review expectations, and a PR checklist.docs/maintenance-audit.mddocumenting technical debt, stale/risky files, missing automation, and deferred work.openpyxlruntime dependency used by the Excel I/O path.app.cli:mainentry point..gitignoreso sample data can remain tracked while local/private data and generated outputs are excluded.Reasoning
The repository has a clear engineering purpose: a real estate valuation kernel with a tested Valuation Intelligence Kernel and CLI pipeline. The largest risk found was not valuation logic itself, but drift between documentation, packaging, and the actual implemented code. This PR tightens those edges without changing core formulas or architecture.
Technical debt identified
src/core/valuation_engine.pyimports modules that do not exist yet, so it should be treated as planned or experimental architecture until completed.README_TOOL.mdand several source docstrings contain encoding artifacts.requirements.txt.outputs/valuation_results.jsonis a generated result snapshot and should not be treated as canonical source.Validation
uv run --python 3.11 --with pytest --with numpy --with pandas --with scipy --with openpyxl --with python-dateutil --with pydantic --with jsonschema --with pyyaml --with python-dotenv --with structlog --with python-json-logger python -m pytestvaluation-core-engineand version1.0.0.Residual risk
The installed console-command smoke test timed out through the heavier editable-install path in the local environment. The underlying test suite passes, and the package entry point now points to the existing CLI module, but a dedicated CLI smoke test is recommended as a follow-up.
Follow-up work
src/core/valuation_engine.pyshould become the public API or be removed/marked experimental until its dependencies exist.python app/cli.pyusing sample data.