Installation#

This page explains how to install salespyforce either from PyPI using pip or from source by cloning the repository and building a wheel with poetry. For prerequisites (Python version, Salesforce org access, API permissions), see the Overview.

Install With pip#

Use pip when you want the simplest setup and you are not modifying the code.

python -m pip install --upgrade pip
python -m pip install salespyforce

To verify the installation:

python -c "import salespyforce; print(salespyforce.__version__)"

Install From Source (Build With poetry)#

Use this approach if you plan to contribute, need unreleased changes, or want to inspect the code.

  1. Clone the repository.

git clone https://github.com/jeffshurtliff/salespyforce.git
cd salespyforce

  1. Install dependencies with Poetry.

poetry install

  1. Build the distribution artifacts (wheel and source distribution).

poetry build

  1. Install the built wheel with pip.

python -m pip install dist/*.whl

If you prefer to use the package in editable mode while developing, you can install it directly from the repository with Poetry’s environment:

poetry run python -m pip install -e .

Troubleshooting#

If installation fails due to missing Python or environment issues, revisit the requirements on the Overview page and confirm your Python version matches the supported range.