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.1.0.20220823

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

Built distribution (wheel)

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

Total release size: 187.1 kB

Release files / squareup-21.1.0.20220823.tar.gz

Download URL squareup-21.1.0.20220823.tar.gz
Size 67.8 kB
Tags Source
SHA-256 checksum
How to use checksums
02dde0a49e7ffa42105e163fb36e00c5b6f68f8523af06e570fb747d2e5e5c5b
BLAKE2b-256 checksum
How to use checksums
09eb7113c1e04fbb649538ef28c9f8e48b5756802661bf7b427e2623a04626a9
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.1.0.20220823-py3-none-any.whl

Download URL squareup-21.1.0.20220823-py3-none-any.whl
Size 119.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6558f16bdadad37c1a338f501adcb60f9eede006fc84a70ca6dd43217a7fd058
BLAKE2b-256 checksum
How to use checksums
256083991f2b3ba459cd3aa0f895d7a5b4f186e183e2515b966bfdef4fd08275
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.1.0.20220823 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