Metadata-Version: 2.4
Name: llama-index-reader-salesforce-npsp
Version: 0.1.0
Summary: A Salesforce NPSP data reader for LlamaIndex to empower data-driven fundraising intelligence.
Project-URL: Homepage, https://github.com/shivamlalakiya/llama-index-reader-salesforce-npsp
Project-URL: Repository, https://github.com/shivamlalakiya/llama-index-reader-salesforce-npsp
Author: Shivam Ashokbhai Lalakiya
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: llama-index-core>=0.10.0
Requires-Dist: simple-salesforce>=1.12.5
Provides-Extra: dev
Requires-Dist: mypy>=1.10.0; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Requires-Dist: ruff>=0.6.0; extra == 'dev'
Description-Content-Type: text/markdown

# llama-index-reader-salesforce-npsp

`llama-index-reader-salesforce-npsp` is a standalone PyPI package that provides a LlamaIndex data reader for Salesforce Nonprofit Success Pack (NPSP), so you can index donor CRM data directly for RAG workflows.

## Installation

```bash
pip install llama-index-reader-salesforce-npsp
```

## Quickstart

```python
from llama_index.readers.salesforce_npsp import SalesforceNPSPReader

reader = SalesforceNPSPReader(
    username="your-salesforce-username",
    password="your-salesforce-password",
    security_token="your-salesforce-security-token",
    domain="login",  # use "test" for sandbox
)

# Load top donors using the built-in NPSP query template
documents = reader.load_data(
    soql_filter="npo02__TotalOppAmount__c > 1000",
    limit=100,
)

# Or fetch specific contacts by Salesforce IDs
vip_documents = reader.load_data(contact_ids=["003XXXXXXXXXXXX", "003YYYYYYYYYYYY"])

print(f"Loaded {len(documents)} Salesforce records.")
```

## Example notebooks

- `examples/salesforce_npsp_fundraising_qa.ipynb`: end-to-end RAG pipeline walkthrough using NPSP fundraising data, from reader ingestion to question-answering over donor records.
