Skip to main content

Library that uses Python to connect to Smartsheet services (using API 2.0).

Project description

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

Contributing

We welcome contributions! Before submitting code changes, please review our Issue First approach for creating effective issues that work well with both human reviewers and AI-powered Cloud Agents. For additional contribution guidelines, see CONTRIBUTING.md.

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:

Project details


Download files

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

Source Distribution

smartsheet_python_sdk-3.7.1.tar.gz (138.7 kB view details)

Uploaded Source

Built Distribution

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

smartsheet_python_sdk-3.7.1-py3-none-any.whl (245.3 kB view details)

Uploaded Python 3

File details

Details for the file smartsheet_python_sdk-3.7.1.tar.gz.

File metadata

  • Download URL: smartsheet_python_sdk-3.7.1.tar.gz
  • Upload date:
  • Size: 138.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for smartsheet_python_sdk-3.7.1.tar.gz
Algorithm Hash digest
SHA256 f0b7388813d4c9d129f01841ef329158d296b1d03f9a0fdd3577df79cbd71777
MD5 2bd04c8741221aeaffbff9c3872fff0d
BLAKE2b-256 bf8e5277f9723803f948898c00915429edd600033a698afbe7e3556818b5e018

See more details on using hashes here.

File details

Details for the file smartsheet_python_sdk-3.7.1-py3-none-any.whl.

File metadata

File hashes

Hashes for smartsheet_python_sdk-3.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 60a5cc89416c6d4d63b11b61aa8fcc33852df22356e24e209a534b64eeb45517
MD5 9551679c7d6c2bbea36ba9b7444533c9
BLAKE2b-256 e3611b3100b3c876b2f5f98f8d966ca1f8dfc15ff190cadc638e0b3ef61b599a

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