Use this library to integrate Square payments into your app and grow your business with Square APIs including Catalog, Customers, Employees, Inventory, Labor, Locations, and Orders.
Use of the Python SDK requires:
- Python 3 version 3.7 or higher
For more information, see Set Up Your Square SDK for a Python Project.
For more information, see Square Python SDK Quickstart.
For more information, see Using the Square Python SDK.
First, clone the repo locally and cd
into the directory.
git clone https://github.com/square/square-python-sdk.git
cd square-python-sdk
Next, install dependencies.
python3 -m pip install .
Before running the tests, find a sandbox token in your Developer Dashboard and set a SQUARE_SANDBOX_TOKEN
environment variable.
export SQUARE_SANDBOX_TOKEN="YOUR SANDBOX TOKEN HERE"
Ensure you have pytest
installed:
python3 -m pip install pytest
And lastly, run the tests.
pytest
The following Square APIs are deprecated:
-
Employees - replaced by the Team API. For more information, see Migrate from the Employees API.
-
Transactions - replaced by the Orders and Payments APIs. For more information, see Migrate from the Transactions API.