Skip to main content

Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.

Project description

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.

python3 -m pip install .

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"

Ensure you have pytest installed:

python3 -m pip install pytest

And lastly, run the tests.

pytest

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:

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

squareup-25.2.0.20230315-py3-none-any.whl (121.2 kB view details)

Uploaded Python 3

File details

Details for the file squareup-25.2.0.20230315-py3-none-any.whl.

File metadata

File hashes

Hashes for squareup-25.2.0.20230315-py3-none-any.whl
Algorithm Hash digest
SHA256 be62184dbcca1a0d3b42ae5f12adb72a38a305072b55f212cac808d6c27c5624
MD5 b52e8d03b5975750e9e0bfdc5d0e1a05
BLAKE2b-256 1c1e6b00828ac182806c4ad93d60cbb9cf7a826160811fddf95589d0f981f0ef

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page