salesforce-api

What it is and what it does

This package provides a Python client for Salesforce's REST and SOAP APIs, abstracting authentication, record operations, and bulk data handling into a simple object-oriented interface. It handles multiple authentication flows (username/password, OAuth2, access tokens) and supports both production and sandbox environments. The core use is managing Salesforce records—inserting, updating, upserting, deleting, and querying Contact, Account, and other SObjects—plus bulk operations for batch processing and metadata inspection.

The library depends on requests for HTTP communication, xmltodict for SOAP payload parsing, and url-normalize for URL handling. It abstracts away pagination automatically for queries and provides both eager and lazy (iterator) query modes. The package is permissively licensed (MIT) and has been in development since 2019, though recent maintenance appears limited.

Use it for:

• Sync contact or account data from an external system into Salesforce via bulk insert or upsert operations.
• Query Salesforce records programmatically and iterate over large result sets without loading all data into memory.
• Build a Python backend service that reads and updates Salesforce records on demand via REST or SOAP.
• Automate record deletion or bulk updates as part of a data cleanup or migration workflow.
• Inspect Salesforce object metadata (field definitions, permissions) to validate or generate schema-aware code.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Wraps Salesforce's REST and SOAP APIs to insert, update, upsert, delete, and query records, with support for bulk operations and metadata introspection.

Yes, with conditions. The package offers a straightforward wrapper around Salesforce APIs and is permissively licensed. However, high install friction, aging maintenance (221 days since last release), and modest adoption (37 stars) suggest it may not be actively developed. Install if you need a lightweight, low-dependency Salesforce client and are comfortable maintaining it yourself; consider alternatives if you require active support or cutting-edge API coverage.

Install

salesforce-api on PyPI

pip install salesforce-api

uv add salesforce-api

poetry add salesforce-api

Installing salesforce-api

Before you install

High install friction reported. Package is aging (221 days since last release) with modest maintenance activity; 37 repository stars suggest limited adoption relative to download volume. Depends on requests, xmltodict, and url-normalize—all common, stable libraries.

License in practice

MIT license is permissive; you can use, modify, and distribute this package freely in commercial and private projects with minimal restrictions.

Quickstart

from salesforce_api import Salesforce

client = Salesforce(
    username='test@example.com',
    password='my-password',
    security_token='password-token'
)

result = client.sobjects.Contact.insert({
    'LastName': 'Example',
    'Email': 'test@example.com'
})

Requires valid Salesforce credentials (username, password, security token, or OAuth client credentials) and network access to Salesforce login endpoints.

Verify before relying

• Whether the package works with current Salesforce API versions beyond those documented in the excerpt.
• Python version compatibility—requires_python is unspecified in the fact sheet.
• Whether bulk operations require specific Salesforce permission sets beyond what the excerpt mentions.
• Current test coverage and stability of the aging codebase.

Package facts

Evidence: salesforce_api-0.1.46.tar.gz

Keywords: salesforce, salesforce api, salesforce bulk api

Tags

More Python Modules packages