Skip to content
This repository has been archived by the owner on Apr 24, 2019. It is now read-only.

Latest commit

 

History

History
56 lines (36 loc) · 3.04 KB

README.md

File metadata and controls

56 lines (36 loc) · 3.04 KB

Build Status Coverage Status

Smartsheet Python SDK

This library is intended to simplify connecting to the Smartsheet API from Python applications.

System Requirements

The SDK currently supports Python 2.7, 3.3, 3.4, 3.5, 3.6, pypy, and pypy3. The following packages are required.

Installation

The SDK can be installed by using a package manager (pip) or manually by downloading the SDK directly from Git. These two steps are outlined below.

Install with pip

If unfamiliar with pip, please review the pip documentation.

This SDK's Python package is called smartsheet-python-sdk. To install using pip:

$ pip install smartsheet-python-sdk

Install manually

To install this SDK manually, download the source code from GitHub and then run:

$ python setup.py install

Documentation

The Smartsheet API is documented here: http://smartsheet-platform.github.io/api-docs/

The Python SDK documentation can be viewed here: http://smartsheet-platform.github.io/smartsheet-python-sdk/.

Getting Started

Getting started with the Python SDK is easy:

  1. Set SMARTSHEET_ACCESS_TOKEN in your environment. Find out more about getting direct API access in the Smartsheet API Documentation.

  2. Install the Smartsheet Python SDK from the Python Package Index, or by using "pip install smartsheet-python-sdk".

  3. Import the smartsheet module: import smartsheet

  4. Refer to the Smartsheet API Documentation for Python SDK usage examples.

See a sample application here: https://github.com/smartsheet-samples/python-read-write-sheet

Support

If you have any questions or issues with this SDK please post on StackOverflow using the tag "smartsheet-api" or contact us directly at api@smartsheet.com.

Contributing

If you would like to contribute a change to the SDK, please fork a branch and then submit a pull request.

Release Notes

Each release with notes is available for download on the Github Releases page.