Library that uses Python to connect to Smartsheet services (using API 2.0).
Project description
Smartsheet Python SDK
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:
-
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.
-
Install the Smartsheet Python SDK (see the installation instructions above)
-
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:
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:
- Tim Wells - timwellswa
- Scott Wimer - happybob007
- Steve Weil - seweil
- Kevin Fansler - kfansler
- Nathan Armstrong - armstnp
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 Distribution
Built Distribution
Hashes for smartsheet-python-sdk-3.0.2.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1f417bef80d088c2133e266a3e33a3636cd3fc1d4e983e4aa6a542b2cec26c8d |
|
| MD5 | ca871a0f00c8f47bd6410a9e51a37549 |
|
| BLAKE2b-256 | 7ff3fc709e818572947dba5e5e51b3d66c3a666c863b9ebd6212d392167d9c19 |
Hashes for smartsheet_python_sdk-3.0.2-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 48a0dc83f0dfbbb9da4dd384d8a296a51df17bac7b9f426d11b179f8153f7b2e |
|
| MD5 | c5dd30aa2b729883303f3c5562bf2400 |
|
| BLAKE2b-256 | 17d7550e16a749bf6cadb2e8ef2b99b9a86c104ea5ee11874a703fce8259ceb9 |
