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 20.1.0.20220720

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

Built distribution (wheel)

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

Total release size: 180.9 kB

Release files / squareup-20.1.0.20220720.tar.gz

Download URL squareup-20.1.0.20220720.tar.gz
Size 65.2 kB
Tags Source
SHA-256 checksum
How to use checksums
be376ced3d00e483c0ec3b6d82795acf3351aa21d69817027cc3cd7e54db016e
BLAKE2b-256 checksum
How to use checksums
34054968a30eb20ae1c1e5f5193470501e74f4be1c831489d07572deb663d713
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-20.1.0.20220720-py3-none-any.whl

Download URL squareup-20.1.0.20220720-py3-none-any.whl
Size 115.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
55d52c90885b3d516c57fe11d82658e5c3fcc47683d31fc60a4f9b1cba910c56
BLAKE2b-256 checksum
How to use checksums
40d6661f8fdc5f39ad644dc4bac07fcbe5959c413322fdaf9a34c0e4dc224a2a
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

20.1.0.20220720 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