Square Python SDK Quickstart

This quickstart sample creates a Square client instance with your Square access token and then lists the locations in your account. The sample is based on the Python SDK Quickstart guide.

Setup

Install Python - If you don't have dotnet already installed on your machine.

Quickstart Instructions

1. Change into the quickstart directory

2. copy .env.example to .env and replace with your access token

   SQUARE_ACCESS_TOKEN=yourSandboxAccessToken
   

3. Create a virtual environment

   $ python3 -m venv env
   

4. Activate the environment

   $ source env/bin/activate
   

5. Install dependencies

   $ pip3 install -r requirements.txt
   

6. Install the latest Square SDK

   $ pip3 install squareup
   

7. [optional] Install the legacy Square SDK, to run the legacy quickstart

   $ pip3 install squareup_legacy
   

8. Run the code

   $ python3 ./quickstart.py
   

9. You should see output similar to this in your console

   LHJ1ZXP3YSV8X: Default Test Account, 1600 Pennsylvania Ave NW, Washington
   

Resources

Square Python SDK Guide - details on how to use / configure the Square client.

Pip repository for Square - Where the package files are hosted

Python SDK Source Code - Github repo with sdk source code