docs: bring CLAUDE.md up to date with the v3.0 Prefect architecture#325
Merged
Conversation
A documentation audit found CLAUDE.md materially stale — it still described the v2.0 in-process pipeline. 13 of 38 verified claims were false. Corrections: * Version v2.0.0 → 3.0.0a0 (per pyproject.toml). * Architecture section rewritten for v3.0: the v2 ``DataProcessingPipeline`` loop and the named ``pipeline.py`` / ``jobs_legacy.py`` files do not exist. Orchestration is ``jobs/prefect_flow.py`` with per-stage ``@task`` functions and the ``datapusher_plus_flow`` entry ``@flow``. Documented the full v3.0 jobs-module layout (prefect_flow, runtime_context, subflows, events, caching, blocks, artifacts, quarantine, file_persistence) and the previously-omitted ``ai_suggestions`` stage. * Key Modules: dropped the non-existent ``jobs_legacy.py``; added ``prefect_client.py``, ``dictionary_stash.py``, ``utils.py``. * Formula type ``suggest_formula`` → ``suggestion_formula`` (the actual scheming-YAML key — verified in jinja2_helpers.py / formula.py). * qsv ``v4.0.0+`` → ``v20.1.0+`` (MINIMUM_QSV_VERSION; two BREAKING bumps since 4.0.0). * ``preview_rows`` default 1000 → 0 (matches config_declaration.yaml and config.py after PR #324). * External Dependencies: RQ → Prefect 3.7+ (the v3.0 runtime; requirements.txt pins prefect, not rq). * CLI commands: added ``prefect-deploy`` and ``migrate-from-rq``. * Build & Test: ``pytest tests/test_unit.py`` (no such file) replaced with a real example + the unit/integration split. Verified-correct claims (plugin.py interface list, formula namespaces, models, job_exceptions, logic actions, Python versions) were left intact. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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
A documentation audit of the project
CLAUDE.mdfound it materially stale — it still described the v2.0 in-process pipeline. 13 of 38 verified claims were false. This PR rewrites the affected sections to match the v3.0 Prefect architecture onmain.Corrections
v2.0.03.0.0a0(perpyproject.toml)pipeline.py→datapusher_plus_to_datastorejobs/prefect_flow.py→datapusher_plus_flow@flowjobs_legacy.pyprefect_flow,runtime_context,subflows,events,caching,blocks,artifacts,quarantine,file_persistence+ the omittedai_suggestionsstagesuggest_formulasuggestion_formula(actual scheming-YAML key)v4.0.0+v20.1.0+(MINIMUM_QSV_VERSION)preview_rowsdefault10000(matchesconfig_declaration.yaml+ PR #324)migrate-from-rqhandles the upgrade)resubmit,submitprefect-deploy,migrate-from-rqpytest tests/test_unit.py(no such file)Verified-correct claims (the
plugin.pyinterface list, formula namespaces, DB models,job_exceptions,logicactions, Python 3.10–3.13) were left intact.Test plan
5bac296(file existence,pyproject.toml,cli.py,config.py,jinja2_helpers.py,requirements.txt).🤖 Generated with Claude Code