Skip to main content

Extending Simple Salesforce to support Pandas exports and more.

Project description

simpler-sf

Extending the low-level Salesforce API client Simple Salesforce to support exports in Pandas, and other features.

Usage

Install

pip install simpler-sf

Importing

import simpler-sf
simpler-sf.simple_salesforce()
import simple_salesforce
# That's it!

smart_query()

Simpler-sf adds the smart_query() method to the simple_salesforce.Salesforce class.

The advantages over the existing methods are:

  • Query results in pd.Dataframe format
  • Un-nesting of results for relationship queries (aka the infamous 'attributes' dictionary)
  • 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 (see example below)
Example
sf = simple_salesforce.Salesforce(username=username, password=password, security_token=token)
df = sf.smart_query('SELECT Contact.Name, Account.Name Id FROM Call')
Example with filtering
sf = simple_salesforce.Salesforce(username=username, password=password, security_token=token)

ids = ['0032400000QZbmtAAD', '0032400000eGqdZAAS', '00324036u9QZbnGAAT', '50130000000014C']
query = \
'''
SELECT
Id,
FirstName,
LastName,
Pronouns,
Phone,
Email
FROM Contact
'''
df = sf.smart_query(query, filter_field='Id', filter_values=ids)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simpler_sf-1.0.0.tar.gz (4.4 kB view hashes)

Uploaded Source

Built Distribution

simpler_sf-1.0.0-py3-none-any.whl (4.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page