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 23.0.0.20221019

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

Built distribution (wheel)

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

Total release size: 172.9 kB

Release files / squareup-23.0.0.20221019.tar.gz

Download URL squareup-23.0.0.20221019.tar.gz
Size 61.8 kB
Tags Source
SHA-256 checksum
How to use checksums
88cd5b713b56bcfb17ba3d4763c778781adf324d6db02c2111292143961401b7
BLAKE2b-256 checksum
How to use checksums
412705598fbbed54bd8ad74fc18eecfe4871227815d1e067bd7f8d68e4867bdd
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-23.0.0.20221019-py3-none-any.whl

Download URL squareup-23.0.0.20221019-py3-none-any.whl
Size 111.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6d473c8e32dbab5b26c99106f1e1e1e073986ecc93a86c369d079d06cc3d1fd9
BLAKE2b-256 checksum
How to use checksums
76fce6a932ab9bdebb8faff093deabfae87557c0e9fdf682f9f33aa92c25701e
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

23.0.0.20221019 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