Skip to main content

Smartsheet Python SDK

Build Status Coverage Status PyPI version

A library for connecting to the Smartsheet API from Python applications.

Requirements

The SDK is compatible with actively supported Python versions 3.10, 3.9, 3.8, 3.7.

Installation

To install using pip:

pip install smartsheet-python-sdk

Getting Started

To get started with the Smartsheet Python SDK:

  1. Set SMARTSHEET_ACCESS_TOKEN in your environment, using your Smartsheet API key. Find out more about Authentication and Access Tokens in the Smartsheet API Documentation. You can generate an access token in Smartsheet UI under Account > Personal Settings > API Access.

  2. Install the Smartsheet Python SDK (see the installation instructions above)

  3. The following snippet shows how to create a Smartsheet client and perform some basic actions using the SDK. Ensure your Smartsheet user has access to at least one sheet.

import smartsheet

smart = smartsheet.Smartsheet()             # Create a Smartsheet client 

response = smart.Sheets.list_sheets()       # Call the list_sheets() function and store the response object
sheetId = response.data[0].id               # Get the ID of the first sheet in the response
sheet = smart.Sheets.get_sheet(sheetId)     # Load the sheet by using its ID

print(f"The sheet {sheet.name} has {sheet.total_row_count} rows")   # Print information about the sheet

Documentation

Use the following resources to learn more about the SDK capabilities:

  1. Smartsheet Python SDK sample project
  2. Python SDK documentation
  3. Smartsheet API Documentation

Advanced Topics

For details about logging, testing, how to use a passthrough option, and how to override HTTP client behavior, see Advanced Topics.

Developer Agreement

Review the Developer Program Agreement.

Acknowledgements

We would like to thank the following people for their contributions to this project:

Metadata

Release files for smartsheet-python-sdk 3.5.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for smartsheet-python-sdk 3.5.2
File Size Uploaded
smartsheet_python_sdk-3.5.2.tar.gz 348.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for smartsheet-python-sdk 3.5.2
File Interpreter ABI Platform
smartsheet_python_sdk-3.5.2-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 839.7 kB

Release files / smartsheet_python_sdk-3.5.2.tar.gz

Download URL smartsheet_python_sdk-3.5.2.tar.gz
Size 348.4 kB
Tags Source
SHA-256 checksum
How to use checksums
5a7d729d0a52c6b64dc8d4fc2408e087a321d6ab3afed3b5ba1c66a845c0b602
BLAKE2b-256 checksum
How to use checksums
65ef372b8d7f34260a149aebc46d0543cecfe62c9c0e5635404855ad9f8e1765
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.18

Release files / smartsheet_python_sdk-3.5.2-py2.py3-none-any.whl

Download URL smartsheet_python_sdk-3.5.2-py2.py3-none-any.whl
Size 491.3 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
d63aaaf1dceea58035864ab2f146bc62f0f9322fa05c4dfabd6515c10bac35e4
BLAKE2b-256 checksum
How to use checksums
490f7ee30d553f81260581ccf4eff4be12681a44c15c8980e2df7b542ab883e9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.18

Release history Release notifications | RSS feed

4.4.0

2 release files

4.3.0

2 release files

4.2.0

2 release files

4.1.0

2 release files

4.0.2

2 release files

4.0.1

2 release files

4.0.0

2 release files

3.9.0

2 release files

3.8.0

2 release files

3.7.2

2 release files

3.7.1

2 release files

3.7.0

2 release files

3.6.0

2 release files

3.5.6

2 release files

3.5.5

2 release files

3.5.4

2 release files

3.5.3

2 release files

This release

3.5.2 This release

2 release files

3.5.1

2 release files

3.5.0

1 release file

3.4.0

2 release files

3.3.0

2 release files

3.2.0

2 release files

3.1.0

2 release files

3.0.5

2 release files

3.0.4

2 release files

3.0.3

2 release files

3.0.2

2 release files

3.0.0

2 release files

2.86.0

2 release files

2.83.0

2 release files

2.68.3

2 release files

2.68.2

2 release files

2.68.1

2 release files

1.5.0

2 release files

1.4.0

2 release files

1.3.3

2 release files

1.3.2

2 release files

1.3.1

2 release files

1.3.0

2 release files

1.2.4

2 release files

1.2.3

2 release files

1.2.2

2 release files

1.2.1

1 release file

1.2.0

2 release files

1.1.0

2 release files

1.0.1

2 release files

1.0.0

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