semvec/pypi-packages huggingface dataset:
simpler-sf 1.0.4
Extending Simple Salesforce to support Pandas exports and more.
License: MIT
Keywords: Salesforce,Simple Salesforce,Pandas,Dataframe,Unpack Salesforce

# simpler-sf
Extending the low-level Salesforce API client [Simple Salesforce](https://github.com/simple-salesforce/simple-salesforce) to support exports in Pandas, and other features.

## Usage
### Install
`pip install simpler-sf`

### Import
```python
import simpler_sf
simpler_sf.simple_salesforce()
import simple_salesforce
```
### Query
Simpler-sf adds the `smart_query()` method to the `simple_salesforce.Salesforce` class.

The advantages over the existing methods are:
- Un-nesting of results for relationship queries (aka the infamous `'attributes'` field) (not just for one level)
- Query results in `pd.Dataframe` format
- No limit on the number of output rows as in `simple_salesforce.Salesforce.query()` **and** at the same time...
- No need to use a different class for each Salesforce object as in `sf.bulk.Account.query(query)`
- The option to filter dynamically, on large amounts of values without a limit on the number of characters

#### Example
```python 
sf = simple_salesforce.Salesforce(username=username, password=password, security_token=token)
df = sf.smart_query('SELECT Contact.Id, Contact.FirstName, Contact.Account.Name, Campaign.Name FROM CampaignMember')
print(df)
```
Output:
```
            Contact.Id   Contact.FirstName   Contact.Account.Name      Campaign.Name
0   0032400000QZbmtAAD               Emily                 Amazon   CampaignA_2023Q2
1   0032400000eGqdZAAS             Jasmine                 Amazon   CampaignA_2023Q2
2   00324036u9QZbnGAAT                Míng              Microsoft   CampaignB_2022Q4
3   0032400000QZbygAAX           Magdalena                 Google   CampaignC_2023Q1
```