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 21.0.0.20220817

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

Built distribution (wheel)

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

Total release size: 187.1 kB

Release files / squareup-21.0.0.20220817.tar.gz

Download URL squareup-21.0.0.20220817.tar.gz
Size 67.8 kB
Tags Source
SHA-256 checksum
How to use checksums
f80764f1e1b8107dd0ea18ff4362be4523a2b691958885fcdc81a0a70bf8a102
BLAKE2b-256 checksum
How to use checksums
f518c7e635c64ae17aa3ad0f9cb03afff64c1ce566e4314606ed3f13ae0c37b7
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-21.0.0.20220817-py3-none-any.whl

Download URL squareup-21.0.0.20220817-py3-none-any.whl
Size 119.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a70019b7a9b25c16bb03d080b06d1995739db1b8f0812dc5befd1b5343ffeffa
BLAKE2b-256 checksum
How to use checksums
00c8e8b12ddaea1b2c2397deae0839ac0c6127559d7a46e02f1d83c7b6ecf7f4
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

21.0.0.20220817 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