feat: add a Neon One (Neon CRM) gift export reader (ingest preset)
维护者通常 1 天内回复
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 25/100
- Issue 类型
- 功能
- 描述清晰度
- 描述清楚
- 活跃度
- 停滞
- 技术栈
- pandas, python, scikit-learn
调研方向
Read philanthropy/ingest/_raisers_edge.py for the existing bridge pattern and philanthropy/ingest/_civicrm.py for the shared aggregator. Verify Neon export labels and pledge/payment terminology against Neon One’s official help center and API docs; then check philanthropy/cli.py for source registration and follow tests/test_raisers_edge.py when adding tests/test_neon.py. Done means the documented aliases and exclusions are tested, exports and stability documentation are updated, and the verification commands pass; an open linked pull request already indicates work is underway.
由索引模型根据 Issue 内容生成。
描述
Status (2026-11-04): PR #314 is open but conflicts with main, and its 2026-10-08 review has had no reply. A second contributor asked for this issue on 2026-10-28. Before starting a new PR, check with the #314 author on that PR.
What's needed
Same pattern as the seven CRM bridges already in philanthropy.ingest (CiviCRM, Raiser's Edge, NPSP, Nonprofit Cloud, Bloomerang, DonorPerfect, Blackbaud CRM): a thin, CRM-specific header-alias map plus a commitment/payment exclusion filter, delegating the roll-up to the shared aggregator in philanthropy/ingest/_civicrm.py. This issue adds the bridge for Neon One / Neon CRM.
Where to look
| File | Purpose |
|---|---|
philanthropy/ingest/_raisers_edge.py |
Closest existing example: header aliasing, a documented default exclusion set, delegation to the shared aggregator |
philanthropy/ingest/_civicrm.py |
The shared aggregator (civicrm_contributions_to_features, read_civicrm_contributions) and its private helpers |
tests/test_raisers_edge.py |
The test depth expected of your new tests/test_neon.py |
philanthropy/ingest/_read_gifts.py |
GIFT_SOURCES and _REGISTRY: the preset registry has landed, so register the new source here. Once #338 merges, philanthropy features --source reads GIFT_SOURCES directly, so there is no CLI dispatch to edit for features |
philanthropy/cli.py |
_read_raw_gifts, used by check and train --task leadership. Once #341 merges, every GIFT_SOURCES name needs an entry there too, and a test fails if one is missing (see step 3) |
What to build
-
philanthropy/ingest/_neon.py: a header-alias map from Neon's real export labels (its donation/transaction export) and its API field names onto the canonicalcontact_id/receive_date/total_amount/gift_typenames; a documented default exclusion parameter for whatever Neon's pledge-vs-payment split actually is (find out exactly how from the docs — do not assume it matches Raiser's Edge or NPSP); aneon_donations_to_features(...)function (name it for what Neon actually calls the record once you've checked); and aread_neon_donations(path)reader delegating toread_civicrm_contributions. -
Verify every field name and every commitment/payment vocabulary term against Neon One's own public help center and API documentation before writing it down. Cite the doc URLs you actually used in your PR body, the way PR #233 does for NPSP. This issue does not assert any field name as fact — confirm everything yourself.
-
Export the new names from
philanthropy/ingest/__init__.py(__all__, alphabetical) and add a stability-tier row todocs/reference/index.md(Tier 2/Beta — a test enforces every public symbol has a row).Then register the source, which the bridges merged since this issue was written all needed:
- Add the name to
GIFT_SOURCESand_REGISTRYinphilanthropy/ingest/_read_gifts.py, and update the hardcoded set intests/test_read_gifts.py(assert set(GIFT_SOURCES) == {...}). - Split the row filter out of your
*_to_featuresfunction into a private_<crm>_received_rows(rows, <filter>=DEFAULT_...)helper and call it from*_to_features, the way_raisers_edge_received_rowsand_npsp_received_rowsdo (#337). The CLI'scheckandtrain --task leadershipread raw gift rows through that helper, so they drop the same pledges and non-gift rowsfeaturesdrops. - If #341 has merged (PR #359), add your source to the CLI's raw-gift reader table in
philanthropy/cli.py; its coverage test fails otherwise. If it has not merged yet, say so in your PR body so whichever lands second adds the other's entry.
- Add the name to
-
tests/test_neon.pyat the depth oftests/test_raisers_edge.py: header aliasing from every spelling the docs name, the commitment/payment double-count trap and its exclusion, the exclusion set being documented/overridable/disabled byNone, currency parsing, schema/dtypes, empty input, missing required columns. -
CHANGELOG.mdentry under## [Unreleased], and add yourself toCONTRIBUTORS.mdif you'd like.
Hard constraints (same as the rest of this ingest series)
- Dependencies stay scikit-learn/pandas/numpy/joblib only — no new package, no API client, no network code anywhere in
philanthropy/. File-export reader only, never a live API connector. - No new estimator class.
- Build the exclusion logic from Neon's own public docs only — never from an institution's actual configuration or data.
- Follow AGENTS.md's order: implement, export, verify with
python -c "...", then write tests, thenmake ci.
Verifying
python -m pip install -e ".[dev]"
python -c "from philanthropy.ingest import neon_donations_to_features, read_neon_donations; print('OK')"
make ci
make riskcov
Claim this issue with a comment before starting; a maintainer assigns within 24 hours.
- 主要语言
- Python
- 星标
- 11
- 派生
- 23
- 平均合并
- 1 天 6 小时
- 30 天内合并 PR
- 34
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
PhilanthroPy-Project/PhilanthroPy 的其他 Issue
-
bug roadmap
难度 2/5 1-3 小时 新手友好度 77/100
PhilanthroPy-Project/PhilanthroPy#366 ·
维护者通常 1 天内回复
-
documentation good first issue roadmap
难度 2/5 1-3 小时 新手友好度 76/100
PhilanthroPy-Project/PhilanthroPy#361 ·
维护者通常 1 天内回复
-
enhancement help wanted roadmap
难度 2/5 1-3 小时 新手友好度 72/100
PhilanthroPy-Project/PhilanthroPy#345 ·
维护者通常 1 天内回复
-
beginner documentation good first issue roadmap
难度 2/5 半天 新手友好度 68/100
PhilanthroPy-Project/PhilanthroPy#342 ·
维护者通常 1 天内回复
-
beginner enhancement good first issue roadmap
难度 2/5 1-3 小时 新手友好度 78/100
PhilanthroPy-Project/PhilanthroPy#340 ·
维护者通常 1 天内回复
查看 PhilanthroPy-Project/PhilanthroPy 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 91/100
marimo-team/marimo#11768 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
btclib-org/btclib-node#2358 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 83/100
-
难度 2/5 1-3 小时 新手友好度 87/100
维护者通常 7 天内回复
-
good first issue
难度 2/5 1-3 小时 新手友好度 78/100
MTSWebServices/RecTools#330 ·