Skip to content

Latest commit

 

History

History
58 lines (47 loc) · 2.54 KB

README.md

File metadata and controls

58 lines (47 loc) · 2.54 KB
Raw

Simple Salesforce Report

Pylint Pytest Code style: black License: MIT

The Salesforce Report Package is a Python library that provides functionality to interact with Salesforce reports using the Simple Salesforce.

Warning

Salesforce Reports and Dashboards REST API only support 2000 rows

Overview

This package enables you to retrieve Salesforce reports and convert them into pandas DataFrames for further analysis and processing within your Python environment. It simplifies the process of fetching Salesforce report data and makes it easy to work with in data analysis workflows.

Important

This only works for salesforce report that do NOT have GROUPED ROWS or GROUPED COLUMNS for now.

Installation

To install the package, you can use pip:

pip install git+https://github.com/weiweikee/simple_salesforce_report

To upgrade the package, you can use:

pip install --upgrade git+https://github.com/weiweikee/simple_salesforce_report

Usage

To use this package

  1. First import the Salesforce_Report object.
from simple_salesforce_report import Salesforce_Report
  1. Providing an environment file containing Salesforce credentials and company information.
sf_report = Salesforce_Report(
        sf_username,
        sf_password,
        sf_security_token,
        sf_domain,
    )

Please refer to example.env for arguments examples.

  1. Then, you can retrieve reports and convert them into pandas DataFrames.
df = sf_report.get_simple_report(report_id)

Dependencies

  • simple_salesforce: A Python library for interacting with Salesforce APIs.
  • pandas: A powerful data manipulation library in Python.

License

This package is licensed under the MIT License. See the LICENSE file for details.