smartsheet-python-sdk 1.2.4__tar.gz → 1.3.1__tar.gz

{smartsheet-python-sdk-1.2.4 → smartsheet-python-sdk-1.3.1}/.gitignore

@@ -29,4 +29,4 @@ smartsheet/version.py
 .pytest_cache/*
 
 # ignore ugly batch files
-*.bat
+*.bat

{smartsheet-python-sdk-1.2.4 → smartsheet-python-sdk-1.3.1}/.travis.yml

@@ -2,7 +2,6 @@ language: python
 
 python:
   - "2.7"
-  - "3.3"
   - "3.4"
   - "3.5"
   - "3.6"
@@ -19,13 +18,13 @@ before_install:
 
 install:
   - pip install --upgrade pip
-  - pip install certifi==2015.04.28
-  - pip install requests six python-dateutil coverage coveralls[yaml] pytest pytest-travis-fold pytest-instafail requests-toolbelt
+  - pip install certifi
+  - pip install enum34 requests six python-dateutil coverage coveralls[yaml] pytest pytest-travis-fold pytest-instafail requests-toolbelt
 
 script:
   - smartsheet-sdk-tests/travis_scripts/start_wiremock.sh
-  - coverage run --source=smartsheet setup.py test -a tests/integration
-  # - coverage run --source=smartsheet setup.py test # use this line instead to enable mock api tests
+  # - coverage run --source=smartsheet setup.py test -a tests/integration
+  - coverage run --source=smartsheet setup.py test # use this line instead to enable mock api tests
 
 after_success:
   - coveralls --verbose

smartsheet-python-sdk-1.3.1/CHANGELOG.md

@@ -0,0 +1,97 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.3.1] - 2018-3-1
+
+### Added
+- Implemented [cross-sheet References](http://smartsheet-platform.github.io/api-docs/?shell#cross-sheet-references)
+- Updated UserProfile and added support for profile images
+- Added an argument to the client constructor method to externally set the API base URI
+- Implemented [Automation Rules](http://smartsheet-platform.github.io/api-docs/?shell#automation-rules)
+- Implemented row sort objects and [Sort Rows in Sheet](http://smartsheet-platform.github.io/api-docs/?shell#sort-rows-in-sheet) endpoint
+- Added row filter properties to SheetFilter
+- Added ifVersionAfter parameter to Sheet.get_sheet() method
+
+### Changed
+In our efforts to further streamline the SDK, enumerated properties have been changed from type String to type EnumeratedValue, which wraps Python Enum. 
+In addition to allowing us to remove a number of redundant string arrays, this also provides the benefit of better code completion (in most IDEs) 
+and provides for more programmatic clarity, for example:
+ ```
+sheet = smartsheet.Sheets.get_sheet(sheet_id)
+if sheet.access_level == AccessLevel.OWNER:
+    # perform some task for OWNER
+    ...
+```
+However, string comparisons will continue to operate as they did previously. No change is required if your code uses comparisons such as:
+```
+sheet = smartsheet.Sheets.get_sheet(sheet_id)
+if sheet.access_level == 'OWNER':
+    # perform some task for OWNER
+    ...
+```
+[enum34](https://pypi.python.org/pypi/enum34) has been added as a required package for the SDK  
+
+## [1.3.0] - 2018-2-21
+
+### Changed 
+
+Several changes have been made to the SDK to improve both the maintainability of the SDK and the predictability/reliability of the results returned by the SDK. Some of these changes may be breaking to code that currently uses the SDK. The following changes should be reviewed:
+* The JSON serializer has been changed to ignore `null` values and empty lists (`[]`). A new Smartsheet model, ExplicitNull, is provided for circumstances where there is a need to force the serialization of a null value. As an example, to clear a hyperlink value from a cell, you can perform the following operation:
+```
+        first_row = Row()
+        first_row.id = 10
+        first_row.cells.append({
+            "columnId": 101,
+            "value": "",
+            "hyperlink": ExplicitNull()
+        })
+
+        response = self.client.Sheets.update_rows(1, [first_row])
+```
+* Property values are more strongly type checked on assignment and you will get a `ValueError` exception if you attempt to assign an incompatible object. Previously, there were a number of cases where assignment of incompatible types would have resulted in a silent failure by the SDK.
+* In previous releases, property filters were executed prior to create or update operations on many models within the SDK. Unfortunately, those filters were sometimes at odds with the API and occasionally returned unpredictable results. For that reason those filters have been removed. Be aware that any property that is set in a model will be passed through to the API.
+* Properties `id`, `format`, and `type` are accessible without the preceding underscore, e.g. `cell._format` has changed to `cell.format`. 
+
+## [1.2.4] - 2018-2-21
+
+### Fixed
+
+- There is a race condition which exists in the window between when the API servers disconnect an idle connection and when the client receives notification 
+of the disconnection. If a request is made during that window, the client reads a blank status line and issues an error indicating that the session was 
+terminated without a response (UnexpectedRequestError). This release is made to address that issue by implementing appropriate retries in the SDK.
+ 
+## [1.2.3] - 2017-12-11
+
+### Fixed
+
+- Safe defaults for mock api test name and module name
+## [1.2.2] - 2017-12-7
+### Added
+- Support for column validation
+- New `Passthrough` object supports `get`, `post`, `put`, or `delete` with arbitrary json payload. Use this for access to any API feature that isn't yet modeled in the API. Requests still benefit from error retry and logging.
+
+- `add_image_to_cell` & `attach_file_to_cell`: Now support `override_validation` and `alt_text` parameters
+- `copy_folder`, `copy_workspace` and `copy_sheet`: Additional options for `include`, `skip_remap`, and `omit` parameters
+- Support for `include=sheetVersion` for several endpoints that return a list of sheets
+- Support for reading sheet filters
+- More flags when publishing Sheets or Reports as HTML
+- Search
+  - Results include favorite information
+  - Limit search scope
+
+### Changed
+- Mock tests
+- Improved logging
+
+### Fixed
+- Sight widget column property name
+
+
+
+## Previous releases
+- Documented as [Github releases](https://github.com/smartsheet-platform/smartsheet-python-sdk/releases)

{smartsheet-python-sdk-1.2.4 → smartsheet-python-sdk-1.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: smartsheet-python-sdk
-Version: 1.2.4
+Version: 1.3.1
 Summary: Library that uses Python to connect to Smartsheet services (using API 2.0).
 Home-page: http://smartsheet-platform.github.io/api-docs/
 Author: Smartsheet
@@ -17,7 +17,7 @@ Description: Smartsheet Python SDK
         System Requirements
         -------------------
         
-        The SDK currently supports Python 2.7, 3.3, 3.4, 3.5, 3.6, pypy, and pypy3.
+        The SDK currently supports Python 2.7, 3.4, 3.5, 3.6, pypy, and pypy3.
         The following packages are required.
         
         -  `requests <https://pypi.python.org/pypi/requests>`__
@@ -25,6 +25,7 @@ Description: Smartsheet Python SDK
         -  `six <https://pypi.python.org/pypi/six>`__
         -  `certifi <https://pypi.python.org/pypi/certifi>`__
         -  `python-dateutil <https://pypi.python.org/pypi/python-dateutil>`__
+        -  `enum34 <https://pypi.python.org/pypi/enum34>`__
         
         Installation
         ------------
@@ -114,7 +115,6 @@ Classifier: Operating System :: OS Independent
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 2.7
-Classifier: Programming Language :: Python :: 3.3
 Classifier: Programming Language :: Python :: 3.4
 Classifier: Programming Language :: Python :: 3.5
 Classifier: Programming Language :: Python :: 3.6

{smartsheet-python-sdk-1.2.4 → smartsheet-python-sdk-1.3.1}/README.md

@@ -4,8 +4,8 @@
 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.  
-**Note** that Python version 3.3 or higher is required for Unicode support. (E.g. if your Smartsheet data includes non-ASCII characters.)  
+The SDK currently supports Python 2.7, 3.4, 3.5, 3.6, pypy, and pypy3.  
+**Note** that Python version 3.4 or higher is required for Unicode support. (E.g. if your Smartsheet data includes non-ASCII characters.)  
 
 The following packages are required.
 

{smartsheet-python-sdk-1.2.4 → smartsheet-python-sdk-1.3.1}/README.rst

@@ -8,7 +8,7 @@ applications.
 System Requirements
 -------------------
 
-The SDK currently supports Python 2.7, 3.3, 3.4, 3.5, 3.6, pypy, and pypy3.
+The SDK currently supports Python 2.7, 3.4, 3.5, 3.6, pypy, and pypy3.
 The following packages are required.
 
 -  `requests <https://pypi.python.org/pypi/requests>`__
@@ -16,6 +16,7 @@ The following packages are required.
 -  `six <https://pypi.python.org/pypi/six>`__
 -  `certifi <https://pypi.python.org/pypi/certifi>`__
 -  `python-dateutil <https://pypi.python.org/pypi/python-dateutil>`__
+-  `enum34 <https://pypi.python.org/pypi/enum34>`__
 
 Installation
 ------------

{smartsheet-python-sdk-1.2.4 → smartsheet-python-sdk-1.3.1}/docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 7c21c13b68a9fc79c2ce1a38524d9d49
+config: 182ba4142853120fe0a76a6374d55800
 tags: 645f666f9bcd5a90fca523b33c5a78b7

smartsheet-python-sdk-1.3.1/docs/_sources/smartsheet.models.enums.rst.txt

@@ -0,0 +1,262 @@
+smartsheet.models.enums package
+===============================
+
+Submodules
+----------
+
+smartsheet.models.enums.access\_level module
+--------------------------------------------
+
+.. automodule:: smartsheet.models.enums.access_level
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.attachment\_parent\_type module
+-------------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.attachment_parent_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.attachment\_sub\_type module
+----------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.attachment_sub_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.attachment\_type module
+-----------------------------------------------
+
+.. automodule:: smartsheet.models.enums.attachment_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.automation\_action\_frequency module
+------------------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.automation_action_frequency
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.automation\_action\_type module
+-------------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.automation_action_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.automation\_rule\_disabled\_reason module
+-----------------------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.automation_rule_disabled_reason
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.cell\_link\_status module
+-------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.cell_link_status
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.column\_type module
+-------------------------------------------
+
+.. automodule:: smartsheet.models.enums.column_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.criteria\_target module
+-----------------------------------------------
+
+.. automodule:: smartsheet.models.enums.criteria_target
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.cross\_sheet\_reference\_status module
+--------------------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.cross_sheet_reference_status
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.currency\_code module
+---------------------------------------------
+
+.. automodule:: smartsheet.models.enums.currency_code
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.day\_descriptors module
+-----------------------------------------------
+
+.. automodule:: smartsheet.models.enums.day_descriptors
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.day\_ordinal module
+-------------------------------------------
+
+.. automodule:: smartsheet.models.enums.day_ordinal
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.global\_template module
+-----------------------------------------------
+
+.. automodule:: smartsheet.models.enums.global_template
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.operator module
+---------------------------------------
+
+.. automodule:: smartsheet.models.enums.operator
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.paper\_type module
+------------------------------------------
+
+.. automodule:: smartsheet.models.enums.paper_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.predecessor\_type module
+------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.predecessor_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.publish\_accessible\_by module
+------------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.publish_accessible_by
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.schedule\_type module
+---------------------------------------------
+
+.. automodule:: smartsheet.models.enums.schedule_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.share\_scope module
+-------------------------------------------
+
+.. automodule:: smartsheet.models.enums.share_scope
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.share\_type module
+------------------------------------------
+
+.. automodule:: smartsheet.models.enums.share_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.sheet\_email\_format module
+---------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.sheet_email_format
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.sheet\_filter\_operator module
+------------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.sheet_filter_operator
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.sheet\_filter\_type module
+--------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.sheet_filter_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.sort\_direction module
+----------------------------------------------
+
+.. automodule:: smartsheet.models.enums.sort_direction
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.symbol module
+-------------------------------------
+
+.. automodule:: smartsheet.models.enums.symbol
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.system\_column\_type module
+---------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.system_column_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.update\_request\_status module
+------------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.update_request_status
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.user\_status module
+-------------------------------------------
+
+.. automodule:: smartsheet.models.enums.user_status
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.widget\_type module
+-------------------------------------------
+
+.. automodule:: smartsheet.models.enums.widget_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: smartsheet.models.enums
+    :members:
+    :undoc-members:
+    :show-inheritance:

{smartsheet-python-sdk-1.2.4 → smartsheet-python-sdk-1.3.1}/docs/_sources/smartsheet.models.rst.txt

@@ -1,6 +1,13 @@
 smartsheet.models package
 =========================
 
+Subpackages
+-----------
+
+.. toctree::
+
+    smartsheet.models.enums
+
 Submodules
 ----------
 
@@ -44,6 +51,22 @@ smartsheet.models.auto\_number\_format module
     :undoc-members:
     :show-inheritance:
 
+smartsheet.models.automation\_action module
+-------------------------------------------
+
+.. automodule:: smartsheet.models.automation_action
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.automation\_rule module
+-----------------------------------------
+
+.. automodule:: smartsheet.models.automation_rule
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 smartsheet.models.boolean\_object\_value module
 -----------------------------------------------
 
@@ -180,6 +203,14 @@ smartsheet.models.criteria module
     :undoc-members:
     :show-inheritance:
 
+smartsheet.models.cross\_sheet\_reference module
+------------------------------------------------
+
+.. automodule:: smartsheet.models.cross_sheet_reference
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 smartsheet.models.currency module
 ---------------------------------
 
@@ -244,18 +275,18 @@ smartsheet.models.error\_result module
     :undoc-members:
     :show-inheritance:
 
-smartsheet.models.favorite module
----------------------------------
+smartsheet.models.explicit\_null module
+---------------------------------------
 
-.. automodule:: smartsheet.models.favorite
+.. automodule:: smartsheet.models.explicit_null
     :members:
     :undoc-members:
     :show-inheritance:
 
-smartsheet.models.filter module
--------------------------------
+smartsheet.models.favorite module
+---------------------------------
 
-.. automodule:: smartsheet.models.filter
+.. automodule:: smartsheet.models.favorite
     :members:
     :undoc-members:
     :show-inheritance:
@@ -628,6 +659,22 @@ smartsheet.models.sight\_publish module
     :undoc-members:
     :show-inheritance:
 
+smartsheet.models.sort\_criterion module
+----------------------------------------
+
+.. automodule:: smartsheet.models.sort_criterion
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.sort\_specifier module
+----------------------------------------
+
+.. automodule:: smartsheet.models.sort_specifier
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 smartsheet.models.source module
 -------------------------------
 
@@ -668,6 +715,14 @@ smartsheet.models.user module
     :undoc-members:
     :show-inheritance:
 
+smartsheet.models.user\_model module
+------------------------------------
+
+.. automodule:: smartsheet.models.user_model
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 smartsheet.models.user\_profile module
 --------------------------------------
 

{smartsheet-python-sdk-1.2.4 → smartsheet-python-sdk-1.3.1}/docs/_static/documentation_options.js

@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: '',
-    VERSION: '1.2.4.dev19+g615bc26.d20180221',
+    VERSION: '1.3.1',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     FILE_SUFFIX: '.html',