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

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.0.5.tar.gz (336.0 kB view details)

Uploaded Source

Built Distribution

smartsheet_python_sdk-3.0.5-py2.py3-none-any.whl (229.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file smartsheet-python-sdk-3.0.5.tar.gz.

File metadata

  • Download URL: smartsheet-python-sdk-3.0.5.tar.gz
  • Upload date:
  • Size: 336.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for smartsheet-python-sdk-3.0.5.tar.gz
Algorithm Hash digest
SHA256 2725192db1eb8121b6a4969fa9d213c54c6a8c5823cb6bbbc64f7b48239507a5
MD5 a20b08b916ba9532a2a79d7878195df6
BLAKE2b-256 ccdc4d06d5c5e74427677036e730c983d9ba818a3cdb5be8e6a8e8ae842ab4e7

See more details on using hashes here.

File details

Details for the file smartsheet_python_sdk-3.0.5-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for smartsheet_python_sdk-3.0.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 339df23a98789a14ab75756c7916a3b21870a7d2ddbe853f302cc4b437fe8863
MD5 946cf57c38b1e1d95b4281665722154f
BLAKE2b-256 ed22174eed88f8b3b5a6a0b2daca8e68a641d7c489d6852896ba927d0fadedbc

See more details on using hashes here.

Supported by

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