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

Deprecated APIs

The following Square APIs are deprecated:

Release files for squareup 22.0.0.20220921

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 22.0.0.20220921
File Size Uploaded
squareup-22.0.0.20220921.tar.gz 68.9 kB Details

Built distribution (wheel)

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

Total release size: 189.5 kB

Release files / squareup-22.0.0.20220921.tar.gz

Download URL squareup-22.0.0.20220921.tar.gz
Size 68.9 kB
Tags Source
SHA-256 checksum
How to use checksums
386c71d686c6f4384cc3f3785ca83cd9915a3dde4bd9e05bbd3caaaeef36f9e2
BLAKE2b-256 checksum
How to use checksums
20cb6d4b143f618df54c1a0cb6ab5566bd6d7b930236dd131576a238d73e2de4
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-22.0.0.20220921-py3-none-any.whl

Download URL squareup-22.0.0.20220921-py3-none-any.whl
Size 120.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5d25c37cd1fa60197b437c27d246124664c2bfaab38ff15bcac71717d5daf75c
BLAKE2b-256 checksum
How to use checksums
76eb42f22b4bf5e4738337afc11ec5c5fd64477b23e5cc1e7187bef43d110115
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

22.0.0.20220921 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