# Smartsheet Python SDK
[](https://github.com/smartsheet/smartsheet-python-sdk/actions/workflows/test-build.yaml) [](https://coveralls.io/github/smartsheet/smartsheet-python-sdk?branch=mainline) [](https://badge.fury.io/py/smartsheet-python-sdk)
A library for connecting to the [Smartsheet API](https://developers.smartsheet.com/api/smartsheet/) from Python applications.
## Requirements
The SDK is compatible with [actively supported](https://devguide.python.org/versions/#versions) Python versions `3.10`, `3.9`, `3.8`, `3.7`.
## Installation
To install using [pip](http://www.pip-installer.org/):
```bash
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](https://developers.smartsheet.com/api/smartsheet/guides/basics/authentication) 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.
``` python
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](https://github.com/smartsheet-samples/python-read-write-sheet)
2. [Python SDK documentation](https://smartsheet.github.io/smartsheet-python-sdk/)
3. [Smartsheet API Documentation](https://developers.smartsheet.com/api/smartsheet/)
## Advanced Topics
For details about logging, testing, how to use a passthrough option, and how to override HTTP client behavior,
see [Advanced Topics](ADVANCED.md).
## Developer Agreement
Review the [Developer Program Agreement](https://www.smartsheet.com/legal/developer-program-agreement).
## Acknowledgements
We would like to thank the following people for their contributions to this project:
* Tim Wells - [timwellswa](https://github.com/timwellswa)
* Scott Wimer - [happybob007](https://github.com/happybob007)
* Steve Weil - [seweil](https://github.com/seweil)
* Kevin Fansler - [kfansler](https://github.com/kfansler)
* Nathan Armstrong - [armstnp](https://github.com/armstnp)
Raw data
{
"_id": null,
"home_page": "http://smartsheet-platform.github.io/api-docs/",
"name": "smartsheet-python-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Smartsheet, Collaboration, Project Management, Excel, spreadsheet",
"author": "Smartsheet",
"author_email": "sdk@smartsheet.com",
"download_url": null,
"platform": null,
"description": "# Smartsheet Python SDK\n\n[](https://github.com/smartsheet/smartsheet-python-sdk/actions/workflows/test-build.yaml) [](https://coveralls.io/github/smartsheet/smartsheet-python-sdk?branch=mainline) [](https://badge.fury.io/py/smartsheet-python-sdk)\n\nA library for connecting to the [Smartsheet API](https://developers.smartsheet.com/api/smartsheet/) from Python applications.\n\n## Requirements\n\nThe SDK is compatible with [actively supported](https://devguide.python.org/versions/#versions) Python versions `3.10`, `3.9`, `3.8`, `3.7`.\n\n## Installation\n\nTo install using [pip](http://www.pip-installer.org/):\n\n```bash\npip install smartsheet-python-sdk\n```\n\n## Getting Started\n\nTo get started with the Smartsheet Python SDK:\n\n1. Set **SMARTSHEET_ACCESS_TOKEN** in your environment, using your Smartsheet API key. Find out more about [Authentication and Access Tokens](https://developers.smartsheet.com/api/smartsheet/guides/basics/authentication) in the Smartsheet API Documentation. You can generate an access token in Smartsheet UI under Account > Personal Settings > API Access.\n\n2. Install the Smartsheet Python SDK (see the installation instructions above)\n\n3. 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.\n\n``` python\n\nimport smartsheet\n\nsmart = smartsheet.Smartsheet() # Create a Smartsheet client \n\nresponse = smart.Sheets.list_sheets() # Call the list_sheets() function and store the response object\nsheetId = response.data[0].id # Get the ID of the first sheet in the response\nsheet = smart.Sheets.get_sheet(sheetId) # Load the sheet by using its ID\n\nprint(f\"The sheet {sheet.name} has {sheet.total_row_count} rows\") # Print information about the sheet\n```\n\n## Documentation\n\nUse the following resources to learn more about the SDK capabilities:\n\n1. [Smartsheet Python SDK sample project](https://github.com/smartsheet-samples/python-read-write-sheet)\n2. [Python SDK documentation](https://smartsheet.github.io/smartsheet-python-sdk/)\n3. [Smartsheet API Documentation](https://developers.smartsheet.com/api/smartsheet/)\n\n## Advanced Topics\n\nFor details about logging, testing, how to use a passthrough option, and how to override HTTP client behavior,\nsee [Advanced Topics](ADVANCED.md).\n\n## Developer Agreement\n\nReview the [Developer Program Agreement](https://www.smartsheet.com/legal/developer-program-agreement).\n\n## Acknowledgements\n\nWe would like to thank the following people for their contributions to this project:\n\n* Tim Wells - [timwellswa](https://github.com/timwellswa)\n* Scott Wimer - [happybob007](https://github.com/happybob007)\n* Steve Weil - [seweil](https://github.com/seweil)\n* Kevin Fansler - [kfansler](https://github.com/kfansler)\n* Nathan Armstrong - [armstnp](https://github.com/armstnp)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Library that uses Python to connect to Smartsheet services (using API 2.0).",
"version": "3.5.0",
"project_urls": {
"Homepage": "http://smartsheet-platform.github.io/api-docs/"
},
"split_keywords": [
"smartsheet",
" collaboration",
" project management",
" excel",
" spreadsheet"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "91818a5247552edb0f47275df48ccb14bf3c3d067e7c8a60e1bfe1843940834c",
"md5": "2250b9f571c12f003e0956a61cdf9cd2",
"sha256": "83f1262457c3884dd6c8717f092a4baad0f4190d3b685935d9f2b2c9921a1d64"
},
"downloads": -1,
"filename": "smartsheet_python_sdk-3.5.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "2250b9f571c12f003e0956a61cdf9cd2",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 237715,
"upload_time": "2025-10-24T14:31:32",
"upload_time_iso_8601": "2025-10-24T14:31:32.562084Z",
"url": "https://files.pythonhosted.org/packages/91/81/8a5247552edb0f47275df48ccb14bf3c3d067e7c8a60e1bfe1843940834c/smartsheet_python_sdk-3.5.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-24 14:31:32",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "smartsheet-python-sdk"
}
JSON