Document the multi-source ingest bridges and the leadership-upgrade model - #246
Merged
Merged
Conversation
…odel README and the docs homepage still only described the CiviCRM and UniSchema on-ramps and the plain propensity-scoring CLI flow. This adds the Raiser's Edge and NPSP bridges, read_gifts as the one-call entry point over all three, map_columns and activities_to_features for the multi-file no-code upload case, and the CLI's --activity/--as-of and train --task upgrade flags that drive the leadership-upgrade model, with a pointer to the new notebook.
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
README and the docs homepage hadn't caught up with the last several PRs: the Raiser's Edge and NPSP gift bridges,
read_giftsas a one-call entry point over all three CRM presets,map_columnsandactivities_to_featuresfor a multi-file no-code upload, andbuild_upgrade_snapshots/score_upgrade_prospectsfor the leadership-upgrade model, plus the CLI's--activity/--as-ofandtrain --task upgradeflags. All of that was only documented in the API reference and the CLI how-to guide, not in the two places most people actually look first.Changes
--sourceexample note now mentions NPSP; new "Multiple files and a built-in upgrade model" subsection under the CLI walkthrough with runnable--activity/--as-ofandtrain --task upgradeexamples; "From your CRM to scores" gained Raiser's Edge and NPSP paragraphs, aread_giftsmention, and a new "Multiple files, one donor table, no glue code" subsection; feature-overview table gained rows for every symbol above; notebooks list now names all five notebooks instead of three.docs/index.md: one new capability row for the upgrade-model flow, matching the existing ledger-row style.CHANGELOG.md: one bullet under## [Unreleased]->### Documentation.Docs-only; no source change.
Test plan
mkdocs build --strict— no broken linkspython -c "from philanthropy.ingest import read_gifts, GIFT_SOURCES, build_upgrade_snapshots, map_columns, activities_to_features, read_raisers_edge_gifts, read_npsp_opportunities; from philanthropy.models import score_upgrade_prospects; print('OK')"make ci— 2216 passed, 98.37% coverage