Skip to main content

Library that uses Python to connect to Smartsheet services (using API 2.0).

Project description

|Build Status| |Coverage Status|

Smartsheet Python SDK
=====================

This library is intended to simplify connecting to the `Smartsheet
API <http://smartsheet-platform.github.io/api-docs/>`__ 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.

- `requests <https://pypi.python.org/pypi/requests>`__
- `requests-toolbelt <https://pypi.python.org/pypi/requests-toolbelt>`__
- `six <https://pypi.python.org/pypi/six>`__
- `certifi <https://pypi.python.org/pypi/certifi>`__
- `python-dateutil <https://pypi.python.org/pypi/python-dateutil>`__

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 <http://www.pip-installer.org/>`__.

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 <https://github.com/smartsheet-platform/smartsheet-python-sdk>`__
and then run:

``$ python setup.py install``

Documentation
-------------

The SDK documentation can be viewed online at
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 <https://smartsheet-platform.github.io/api-docs/index.html#direct-api-access>`__
in the Smartsheet API Documentation.

2. Install the Smartsheet Python SDK from the `Python Package
Index <http://pypi.python.org/pypi/smartsheet-python-sdk>`__, or by
using "pip install smartsheet-python-sdk".

3. Import the smartsheet module: ``import smartsheet``

4. Refer to the `Smartsheet API
Documentation <https://smartsheet-platform.github.io/api-docs/?python#python-sample-code>`__
for Python SDK usage examples.

Contributing
------------

If you would like to contribute a change to the SDK, please fork a
branch and then submit a pull request. More info
`here <https://help.github.com/articles/using-pull-requests>`__.

Support
-------

If you have any questions or issues with this SDK please post on
StackOverflow using the tag
`"smartsheet-api" <http://stackoverflow.com/questions/tagged/smartsheet-api>`__
or contact us directly at api@smartsheet.com.

Release Notes
-------------

Each specific release is available for download via
`Github <https://github.com/smartsheet-platform/smartsheet-python-sdk/tags>`__.

See [CHANGELOG.md](https://github.com/smartsheet-platform/smartsheet-python-sdk/blob/master/CHANGELOG.md)


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-1.2.3.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

smartsheet_python_sdk-1.2.3-py2.py3-none-any.whl (210.9 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for smartsheet-python-sdk-1.2.3.tar.gz
Algorithm Hash digest
SHA256 643499d16a05491b74e6df96a626aaa3a3cc923f111d78bb3ef91dfc544e6ff5
MD5 978fc2735cade2665a08198dfc955759
BLAKE2b-256 ffeb004f92c3004f0ca14038fe706fc3220f59366298d583b5a99e32ac337d37

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for smartsheet_python_sdk-1.2.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3e64212d03e17d0ae10bb8b3bec1599ad52fab111e3267b7d885ec7fc9e097f3
MD5 76f53096c1b5ef1b5b78b8c4be181317
BLAKE2b-256 2a8d022dea55983be58f8e169dce643da254f37786eaba06f0f068d8fbd949a8

See more details on using hashes here.

Supported by

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