Skip to content

Installation

Requirements

Use a virtual environment

Always install packages inside a virtual environment (python -m venv .venv) to avoid conflicts with system packages.

Core Package

Install the core package with support for Stripe and PayPal stubs:

pip install merchants-sdk

Optional Provider Extras

Some providers depend on additional packages. Install them as extras:

pip install "merchants-sdk[flow]"

Installs pyflowcl for Flow.cl payments (Chile).

pip install "merchants-sdk[khipu]"

Installs khipu-tools for Khipu payments (Chile).

pip install "merchants-sdk[flow,khipu]"

Development

To work on merchants locally, clone the repository and install in editable mode with dev dependencies:

git clone https://github.com/mariofix/merchants.git
cd merchants
pip install -e ".[dev]"

Dev extras include pytest, pytest-cov, ruff, and responses.

Verify Installation

import merchants
print(merchants.__version__)

Installation successful

If no ImportError is raised and a version string is printed, merchants is correctly installed.