# 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://smartsheet.redoc.ly) 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://smartsheet.redoc.ly/#section/API-Basics/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.
``` 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://smartsheet.redoc.ly)
## 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": "https://files.pythonhosted.org/packages/8c/32/052a6734c3aac0353de1e44ed8e2ca37f85c17772ea8b50456ba135e8a5b/smartsheet-python-sdk-3.0.4.tar.gz",
"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://smartsheet.redoc.ly) 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://smartsheet.redoc.ly/#section/API-Basics/Authentication-and-Access-Tokens) 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://smartsheet.redoc.ly)\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.0.4",
"project_urls": {
"Homepage": "http://smartsheet-platform.github.io/api-docs/"
},
"split_keywords": [
"smartsheet",
" collaboration",
" project management",
" excel",
" spreadsheet"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3e36931beac1bb6b600c515d48f3cb78ec6abca05dea75e209fada7285d21518",
"md5": "89c205ec65dfe54ffb004b3ef1f4f210",
"sha256": "f5af68d177964814cd2930bbad618d5bf965a5a6194e09ef059fa2968030f7b9"
},
"downloads": -1,
"filename": "smartsheet_python_sdk-3.0.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "89c205ec65dfe54ffb004b3ef1f4f210",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 229612,
"upload_time": "2024-07-30T10:18:11",
"upload_time_iso_8601": "2024-07-30T10:18:11.509173Z",
"url": "https://files.pythonhosted.org/packages/3e/36/931beac1bb6b600c515d48f3cb78ec6abca05dea75e209fada7285d21518/smartsheet_python_sdk-3.0.4-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8c32052a6734c3aac0353de1e44ed8e2ca37f85c17772ea8b50456ba135e8a5b",
"md5": "827cc12a05f05344ea00ebd022ee75f6",
"sha256": "c38e3cc7a42564e06e265ac4bd169673e8ecc2405ac1dd32c4bdc3799e900462"
},
"downloads": -1,
"filename": "smartsheet-python-sdk-3.0.4.tar.gz",
"has_sig": false,
"md5_digest": "827cc12a05f05344ea00ebd022ee75f6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 333935,
"upload_time": "2024-07-30T10:18:13",
"upload_time_iso_8601": "2024-07-30T10:18:13.016643Z",
"url": "https://files.pythonhosted.org/packages/8c/32/052a6734c3aac0353de1e44ed8e2ca37f85c17772ea8b50456ba135e8a5b/smartsheet-python-sdk-3.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-30 10:18:13",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "smartsheet-python-sdk"
}
JSON