Square Python SDK
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.
Requirements
Use of the Python SDK requires:
- Python 3 version 3.7 or higher
Installation
For more information, see Set Up Your Square SDK for a Python Project.
Quickstart
For more information, see Square Python SDK Quickstart.
Usage
For more information, see Using the Square Python SDK.
Tests
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
SDK Reference
Payments
Terminal
Orders
Subscriptions
Invoices
Items
Customers
Loyalty
Gift Cards
Bookings
Business
Team
Financials
Online
Authorization
Webhook Subscriptions
Deprecated APIs
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.
5 maintainers
Metadata
5 maintainers
Release files for squareup 38.2.0.20241017
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| squareup-38.2.0.20241017-py3-none-any.whl | Python 3 | none | any | Details for squareup-38.2.0.20241017-py3-none-any.whl |
Release files / squareup-38.2.0.20241017-py3-none-any.whl
| Download URL | squareup-38.2.0.20241017-py3-none-any.whl |
|---|---|
| Size | 116.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
045284cc607b15d00e787ecad5b9f5cc80eacab6aeadc05051341db6df1a3564
|
|
BLAKE2b-256 checksum How to use checksums |
0c95ab7a49ab97d5ac5b888c2b57d3212b6f76921fabfcd4c6ab6e0d705e25ed
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.8.15
|
Security for squareup 38.2.0.20241017
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
