Changelog
All notable changes to this project will be documented in this file.
[Unreleased]
Added
- Branching & commit conventions enforced in CI (
.github/workflows/branch-name.yml,.github/workflows/semantic-pr.yml) and documented inCONTRIBUTING.md. CLAUDE.md— guidance for Claude Code / future AI agents working in this repo.docs/stream-api.md— SSE event shapes for/streamand/stream/mock.scripts/capture_readme_assets.sh— helper to refresh README screenshots (macOS-friendly)..github/dependabot.yml— weekly pip and GitHub Actions updates.- Scoped
mypyin CI andmake typecheckforsrc.crew.schemas._baseandsrc.crew.structured_output. - Tests:
DownloadPipelinefailure/success branches (tests/core/test_download_pipeline.py); crew kickoff failure (tests/crew/test_pipeline_failure.py). - Schema tests for
normalize_payload_listsviaValuationOutputvalidation.
Changed
- Packaging:
hatchlingbuild backend +srcas an installable package souv sync/pip install -e .expose thesrc.*imports (tests and CI rely on this). DownloadPipelinesetscritical_okonly after successful critical steps including CSV save;StockProcessorusescritical_okfor_download_ok(fixes aborted financials/save still proceeding to analysis).- Docker image builds with
uv sync --frozen --no-devanduv.lockfor reproducible runtime deps. - CI installs with
uv sync --frozen --extra devto match local lockfile workflows.
Fixed
- README Quickstart clone URL now points at the canonical GitHub repo.
Notes
- Git history before
0.1.0was squashed. Early commits were personal PoC work and not intended for sharing, so the pre-squash history is not preserved.
[0.1.0] - 2026-04-06
Added
- OSS community baseline:
CONTRIBUTING.md,CODE_OF_CONDUCT.md,SECURITY.md. - GitHub collaboration scaffolding: issue templates, PR template, and CI workflow.
- Provider-aware environment preflight command:
python -m src.core.config.check. - Docs set for setup and architecture:
docs/local-setup.mddocs/model-providers.mddocs/architecture.mddocs/self-host.mddocs/examples/crew-output-guide.mddocs/examples/output-preview.md- Integration tests for SSE streaming and processor orchestration.
- Manual crew runner moved to
scripts/run_crew.py.
Changed
- README refocused around local-first usage with provider matrix and example-output links.
- User-facing stream/pipeline failures now emit sanitized messages with log reference IDs.
- Removed runtime/path bootstrapping hacks (
sys.path.insert) from app/tests. - Dependency cleanup in
pyproject.toml: - removed direct
plotlydependency (unused) - removed direct
urllib3<2pin
Removed
- Root-level generated artifact docs and machine files:
CREW_OUTPUT.mdmoved intodocs/examples/.DS_Storeremoved