Skip to main content

Square logo

Square Python SDK

Build PyPi version Apache-2 license

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.

pip install -r test-requirements.txt

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"

And run the tests.

nosetests tests

SDK Reference

Payments

Terminal

Orders

Subscriptions

Invoices

Items

Customers

Loyalty

Gift Cards

Bookings

Business

Team

Financials

Online

Authorization APIs

Deprecated APIs

Release files for squareup 19.1.0.20220616

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for squareup 19.1.0.20220616
File Size Uploaded
squareup-19.1.0.20220616.tar.gz 65.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for squareup 19.1.0.20220616
File Interpreter ABI Platform
squareup-19.1.0.20220616-py3-none-any.whl Python 3 none any Details

Total release size: 180.5 kB

Release files / squareup-19.1.0.20220616.tar.gz

Download URL squareup-19.1.0.20220616.tar.gz
Size 65.0 kB
Tags Source
SHA-256 checksum
How to use checksums
5efa05efde5708a8d2ed7c647b2e4aa9427189248916f7ecb3f9b1fe4454158c
BLAKE2b-256 checksum
How to use checksums
c9a0e24eb164e4c539cdd24b391e89224ed3080df4c4f20c63d5f684cf847425
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.12

Release files / squareup-19.1.0.20220616-py3-none-any.whl

Download URL squareup-19.1.0.20220616-py3-none-any.whl
Size 115.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
af2940a51368bce3c2fbd9bc697b34f32ed4d2c145c28e914625b88b49b69a6a
BLAKE2b-256 checksum
How to use checksums
f00750b3f927cf478ada21816fd26adfbb8bec9e941e666477a704c8e33b959e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.12

Release history Release notifications | RSS feed

This release

19.1.0.20220616 This release

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page