docs: README and "Get your CRM export in" omit the Nonprofit Cloud, Bloomerang, DonorPerfect and Blackbaud CRM readers

Abierto
  • ¿Algo no está bien?
#339 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

@HarshRajSinghania ya está trabajando en esto.

Desde el 3/11/2026.

  • #355 de @HarshRajSinghania — abierto

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
python
Área
documentation

Línea de trabajo

Start with the read_gifts row and the Raiser's Edge and NPSP paragraphs in README.md, then the DonorPerfect section of docs/how-to/get_your_crm_export_in.md. Take each missing reader's filter description from its docstring in philanthropy/ingest/ and index the readers in docs/reference/index.md. Done when the four readers appear in both pages and mkdocs build --strict passes. Open pull request #355 already targets this, so check it before starting.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

beginner documentation good first issue roadmap

The ingest docs list fewer CRMs than the package supports. read_gifts has seven presets (GIFT_SOURCES), but:

  • README.md (the "Blackbaud Raiser's Edge / RE NXT" and "Salesforce NPSP" paragraphs around line 218, and the API table around line 285) only describes CiviCRM, Raiser's Edge and NPSP, and its read_gifts row still says "One entry point over the CiviCRM / Raiser's Edge / NPSP presets".
  • docs/how-to/get_your_crm_export_in.md covers Raiser's Edge, DonorPerfect and the generic path, but never mentions Salesforce Nonprofit Cloud, Bloomerang or Blackbaud CRM (Enterprise).

docs/reference/index.md already has a row for each reader, so the information exists; it just has not reached the pages a new user reads first.

What to do

  1. In README.md, update the read_gifts table row to say it covers every preset in GIFT_SOURCES (no list of names, so it does not go stale again), and add a one-line table row each for nonprofit_cloud_gifts_to_features / read_nonprofit_cloud_gifts, bloomerang_transactions_to_features / read_bloomerang_transactions, donorperfect_gifts_to_features / read_donorperfect_gifts and blackbaud_crm_revenue_to_features / read_blackbaud_crm_revenue.
  2. In docs/how-to/get_your_crm_export_in.md, add a short paragraph for each of the three missing CRMs, following the DonorPerfect section's shape: the read_gifts(..., source="...") call and what the default filter drops. Take the filter description from each function's docstring, not from memory.
  3. Run mkdocs build --strict to check links.

No fundraising knowledge needed; everything is in the module docstrings under philanthropy/ingest/.

Lenguaje dominante
Python
Estrellas
11
Forks
23
Merge medio
1 d 6 h
PR fusionados (30 d)
34

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de PhilanthroPy-Project/PhilanthroPy

Todos los issues de PhilanthroPy-Project/PhilanthroPy

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.