smartsheet-python-sdk 3.5.4__tar.gz → 3.5.6__tar.gz

{smartsheet_python_sdk-3.5.4 → smartsheet_python_sdk-3.5.6}/.github/pull_request_template.md

@@ -35,6 +35,7 @@
 - [ ] I have performed a self-review of my own code
 - [ ] I have commented my code, particularly in hard-to-understand areas
 - [ ] I have made corresponding changes to the documentation
+- [ ] I have updated the relevant files in `docs-source/` (see [Documentation guidelines](../../../CONTRIBUTING.md#documentation))
 - [ ] My changes generate no new warnings
 - [ ] I have added tests that prove my fix is effective or that my feature works
 - [ ] New and existing unit tests pass locally with my changes

{smartsheet_python_sdk-3.5.4 → smartsheet_python_sdk-3.5.6}/.github/workflows/publish-distribution.yaml

@@ -10,16 +10,19 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - name: Set up Python 3.10
+      - name: Set up Python 3.14
         uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
+          python-version: '3.14'
       - name: Install build packages
         run: |
-          pip install enum34 requests six python-dateutil setuptools-scm==7.1.0 gitchangelog mako wheel twine sphinx sphinx_rtd_theme
+          pip install build
+      - name: Install packaging dependencies
+        run: |
+          pip install .[packaging]
       - name: Build distribution
         run: |
-          python setup.py sdist bdist_wheel
+          python -m build
       - name: Archive distribution artifacts
         uses: actions/upload-artifact@v4
         with:

{smartsheet_python_sdk-3.5.4 → smartsheet_python_sdk-3.5.6}/.github/workflows/publish-documentation.yaml

@@ -10,13 +10,16 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - name: Set up Python 3.10
+      - name: Set up Python 3.14
         uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
+          python-version: '3.14'
       - name: Install build packages
         run: |
-          pip install enum34 requests six python-dateutil setuptools-scm==7.1.0 gitchangelog mako wheel twine sphinx sphinx_rtd_theme
+          pip install build
+      - name: Install documentation dependencies
+        run: |
+          pip install .[docs]
       - name: Generate documentation
         run: |
           sphinx-apidoc -o docs-source smartsheet

{smartsheet_python_sdk-3.5.4 → smartsheet_python_sdk-3.5.6}/.github/workflows/test-build.yaml

@@ -10,33 +10,27 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
+          python-version: '3.14'
       - name: Install dependencies
         run: |
-          pip install pylint requests six python-dateutil
+          pip install build
+      - name: Install project and lint dependencies
+        run: |
+          pip install .[develop]
       - name: Run Markdown Lint
         uses: articulate/actions-markdownlint@v1
         with:
           ignore: ./LICENSE.md
       - name: Run Pylint
         run: |
-          pylint smartsheet --rcfile pylintrc
+          pylint smartsheet
 
-  mock-api-test:
+  test:
     needs: lint
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
-        include:
-          - python-version: "3.7"
-            os: ubuntu-22.04
-          - python-version: "3.8"
-            os: ubuntu-latest
-          - python-version: "3.9"
-            os: ubuntu-latest
-          - python-version: "3.10"
-            os: ubuntu-latest
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
 
     steps:
       - uses: actions/checkout@v4
@@ -44,12 +38,13 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-          os: ${{ matrix.os }}
       - name: Install Python dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install certifi enum34 requests six python-dateutil coverage coveralls[yaml] pytest pytest-instafail requests-toolbelt setuptools-scm
-          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          pip install build
+      - name: Install test dependencies
+        run: |
+          pip install .[test]
       - name: Clone smartsheet/smartsheet-sdk-tests PUBLIC repository
         uses: GuillaumeFalourd/clone-github-repo-action@v2
         with:
@@ -58,9 +53,9 @@ jobs:
       - name: Setup Mock API
         run: |
           docker compose -f smartsheet-sdk-tests/docker-compose.yml up -d --wait
-      - name: Run mock API tests
+      - name: Run tests
         run: |
-          coverage run --source=smartsheet -m pytest tests/mock_api/
+          coverage run --source=smartsheet -m pytest
           coverage lcov
       - name: Coveralls Parallel
         uses: coverallsapp/github-action@master
@@ -72,17 +67,17 @@ jobs:
 
   build-packages-test:
     runs-on: ubuntu-latest
-    needs: [mock-api-test]
+    needs: [test]
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python
         uses: actions/setup-python@v4
       - name: Install build packages
         run: |
-          pip install enum34 requests six python-dateutil setuptools-scm==7.1.0 gitchangelog mako wheel twine
+          pip install build
       - name: Build distribution
         run: |
-          python setup.py sdist bdist_wheel
+          python -m build
       - name: Archive distribution artifacts
         uses: actions/upload-artifact@v4
         with:
@@ -97,7 +92,10 @@ jobs:
       - uses: actions/checkout@v4
       - name: Install documentation tools
         run: |
-          pip install sphinx sphinx_rtd_theme setuptools-scm
+          pip install build
+      - name: Install documentation dependencies
+        run: |
+          pip install .[docs]
       - name: Generate API documentation
         run: sphinx-apidoc -o docs-source smartsheet
       - name: Generate HTML

{smartsheet_python_sdk-3.5.4 → smartsheet_python_sdk-3.5.6}/.gitignore

@@ -12,8 +12,7 @@ smartsheet*.egg-info/
 # Ignore SDK reference docs artifacts
 gh-pages/
 docs-source/_build/
-docs-source/modules.rst
-docs-source/smartsheet*.rst
+docs-source/_static/
 
 # Ignore the test cases log files
 *.log

{smartsheet_python_sdk-3.5.4 → smartsheet_python_sdk-3.5.6}/ADVANCED.md

@@ -4,9 +4,9 @@
 
 The following packages are required.
 
-* [setuptools](https://pypi.org/project/setuptools/)
-* [six](https://pypi.python.org/pypi/six)
-* [requests](https://pypi.python.org/pypi/requests)
+- [setuptools](https://pypi.org/project/setuptools/)
+- [six](https://pypi.python.org/pypi/six)
+- [requests](https://pypi.python.org/pypi/requests)
 
 To install this SDK manually:
 
@@ -55,9 +55,9 @@ To invoke the passthrough, your code can call one of the following four methods:
 
 `response = client.Passthrough.delete(endpoint)`
 
-* `endpoint`: The specific API endpoint you wish to invoke. The client object base URL gets prepended to the caller’s endpoint URL argument, so in the above `get` example, if endpoint is `'/sheets'` an HTTP GET is requested from the URL `https://api.smartsheet.com/2.0/sheets`
-* `payload`: The data to be passed through, can be either a dictionary or string.
-* `query_params`: An optional dictionary of query parameters.
+- `endpoint`: The specific API endpoint you wish to invoke. The client object base URL gets prepended to the caller’s endpoint URL argument, so in the above `get` example, if endpoint is `'/sheets'` an HTTP GET is requested from the URL `https://api.smartsheet.com/2.0/sheets`
+- `payload`: The data to be passed through, can be either a dictionary or string.
+- `query_params`: An optional dictionary of query parameters.
 
 All calls to passthrough methods return a JSON result. The `data` attribute contains the JSON result as a dictionary. For example, after a PUT operation the API's result message will be contained in `response.data['message']`. If you prefer raw JSON instead of a dictionary, you can use the `to_json()` method, for example `response.to_json()`.
 
@@ -78,17 +78,91 @@ response = client.Passthrough.post('/sheets', payload)
 
 ## Testing
 
-### Integration Tests
+### Mock API Tests
 
-1. Follow the [Integration test instructions](tests/integration/README.md)
-2. Run `pytest tests/integration`
+We use WireMock for API contract testing. This allows us to simulate Smartsheet API responses and run tests without relying on the live API.
+The [smartsheet-sdk-tests](https://github.com/smartsheet/smartsheet-sdk-tests) repo provides a standalone WireMock server with JSON mappings that simulate the Smartsheet API.
+Each mapping defines a request to match and a response to return.
+
+Common test cases use catch-all path patterns (e.g., /errors/500-response).
+
+We use two custom headers:
+
+- x-test-name: Used for exact mapping match, allowing different mock responses for the same HTTP method and endpoint.
+- x-request-id: A UUID generated for each request, used to verify request URLs and search for requests in WireMock admin history.
+
+To run the mock API tests:
+
+1. Clone the [smartsheet-sdk-tests](https://github.com/smartsheet/smartsheet-sdk-tests) repo and follow the instructions from the readme to start the mock server.
+
+2. `pytest tests/mock_api`
+
+To add new mock API tests:
+
+1. Add a WireMock Mapping (JSON) in the [smartsheet-sdk-tests](https://github.com/smartsheet/smartsheet-sdk-tests):
+
+```json
+{
+  "request": {
+    "urlPathTemplate": "/2.0/users/{userId}/plans",
+    "method": "GET",
+    "headers": {
+      "Authorization": {
+        "matches": "Bearer .*"
+      },
+      "x-test-name": {
+        "equalTo": "/users/list-user-plans/all-response-body-properties"
+      },
+      "x-request-id": {
+        "matches": ".*"
+      }
+    }
+  },
+  "response": {
+    "statusMessage": "OK",
+    "status": 200,
+    "jsonBody": {
+      "lastKey": "12345678901234569",
+      "data": [
+        {
+          "planId": 1234567890123456,
+          "seatType": "MEMBER",
+          "seatTypeLastChangedAt": "2025-01-01T00:00:00.123456789Z",
+          "provisionalExpirationDate": "2026-12-13T12:17:52.525696Z",
+          "isInternal": false
+        }
+      ]
+    },
+    "headers": {
+      "Content-Type": "application/json"
+    }
+  }
+}
+```
 
-### Mock API Tests
+<!-- markdownlint-disable MD029 -->
+2. Write a Test in the SDK:
+<!-- markdownlint-enable MD029 -->
 
-**NOTE:** the mock API tests will fail unless the mock server is running.
+- Always use x-test-name to target specific mock responses.
+- Use x-request-id for traceability in WireMock admin.
+- Keep mappings in the smartsheet-sdk-tests repository organized and descriptive
 
-1. Clone the [Smartsheet SDK tests](https://github.com/smartsheet-platform/smartsheet-sdk-tests) repo and follow the instructions from the README to start the mock server
-2. Run `pytest tests/mock_api`
+```python
+    def test_list_user_plans_all_response_properties():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/users/list-user-plans/all-response-body-properties", request_id
+    )
+
+    response = client.Users.list_user_plans(
+        user_id=TEST_USER_ID,
+        last_key=TEST_LAST_KEY,
+        max_items=TEST_MAX_ITEMS
+    )
+
+    assert isinstance(response, TokenPaginatedResult)
+```
 
 ## HTTP Proxy
 

{smartsheet_python_sdk-3.5.4 → smartsheet_python_sdk-3.5.6}/CHANGELOG.md

@@ -5,6 +5,39 @@ 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).
 
+## [3.5.6] - 2025-11-18
+
+### Removed
+
+- Remove integration tests from the sdk test suite
+
+### Added
+
+- Add support for code completion. Now code editors will be able to recognize and complete expressions like `smart.Users` and `smart.Users.list_users`.
+
+### Updated
+
+- Improved the generated reference documentation.
+- ADVANCED.md integration and mock api testing documentation
+
+## [3.5.5] - 2025-11-11
+
+### Fixed
+
+- Fix response body logging. When the response Content-Type is application/json the response body is logged.
+
+### Added
+
+- WiremMock integration tests for contract testing for GET /2.0/users/{userId}/plans and GET /2.0/users endpoints
+- WireMock integration tests for contract testing for POST /2.0/users/{userId}/plans/{planId}/upgrade and POST /2.0/users/{userId}/plans/{planId}/downgrade
+- WireMock integration tests for contract testing for DELETE /{userId}/plans/{planId} endpoint
+- Add dict serialization tests
+- Add missing properties from [AssetShare](smartsheet/models/asset_share.py): `cc_me`, `message`, `subject`.
+
+### Updated
+
+- Folder structure for the Users related WireMock tests
+
 ## [3.5.4] - 2025-10-31
 
 ### Fixed

{smartsheet_python_sdk-3.5.4 → smartsheet_python_sdk-3.5.6}/CONTRIBUTING.md

@@ -36,6 +36,27 @@ Changes that are cosmetic in nature and do not add anything substantial to the s
 
 - Write unit tests for new features and bug fixes. All tests should pass before submitting a PR.
 
+## Documentation
+
+- If your changes affect the public API, you must update the corresponding Sphinx documentation files in `docs-source/`:
+  - **API Resources** (modules in `smartsheet/`): Update `docs-source/smartsheet_api.rst`
+  - **Models** (classes in `smartsheet/models/`): Update `docs-source/smartsheet_models.rst`
+  - **Enums** (enums in `smartsheet/models/enums/`): Update `docs-source/smartsheet_enums.rst`
+  - **Types** (type definitions in `smartsheet/types.py`): Update `docs-source/smartsheet_types.rst`
+  - **Exceptions** (exceptions in `smartsheet/exceptions.py`): Update `docs-source/smartsheet_exceptions.rst`
+  - **General documentation** (installation, quickstart, examples): Update `docs-source/index.rst`
+
+- The documentation uses Sphinx with autodoc to generate API documentation from docstrings. Ensure your docstrings follow Google-style format as configured in `docs-source/conf.py`.
+
+- After making changes to `docs-source/`, you can build the documentation locally to verify your changes:
+
+  ```bash
+  cd docs-source
+  make html
+  ```
+
+- The built documentation will be in `docs-source/_build/html/`. Open `index.html` in a browser to review your changes.
+
 ## Running Tests
 
 - To run the test suite, use the following command:

{smartsheet_python_sdk-3.5.4 → smartsheet_python_sdk-3.5.6}/PKG-INFO

@@ -1,24 +1,25 @@
 Metadata-Version: 2.4
-Name: smartsheet_python_sdk
-Version: 3.5.4
+Name: smartsheet-python-sdk
+Version: 3.5.6
 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
-Author-email: sdk@smartsheet.com
-License: Apache-2.0
-Keywords: Smartsheet,Collaboration,Project Management,Excel,spreadsheet
+License-Expression: Apache-2.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Office/Business :: Financial :: Spreadsheet
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
 License-File: NOTICE
@@ -31,23 +32,24 @@ Provides-Extra: test
 Requires-Dist: coverage; extra == "test"
 Requires-Dist: coveralls; extra == "test"
 Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-rerunfailures; extra == "test"
+Requires-Dist: requests-toolbelt; extra == "test"
 Provides-Extra: develop
 Requires-Dist: coverage; extra == "develop"
 Requires-Dist: coveralls[yaml]; extra == "develop"
 Requires-Dist: pytest; extra == "develop"
 Requires-Dist: pytest-instafail; extra == "develop"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
+Requires-Dist: pylint; extra == "develop"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx_rtd_theme; extra == "docs"
+Requires-Dist: setuptools_scm; extra == "docs"
+Provides-Extra: packaging
+Requires-Dist: wheel; extra == "packaging"
+Requires-Dist: twine; extra == "packaging"
+Requires-Dist: gitchangelog; extra == "packaging"
+Requires-Dist: mako; extra == "packaging"
 Dynamic: license-file
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: summary
 
 # Smartsheet Python SDK
 

smartsheet_python_sdk-3.5.6/docs-source/index.rst

@@ -0,0 +1,141 @@
+.. toctree::
+    :maxdepth: 2
+    :hidden:
+
+    smartsheet_api
+    smartsheet_models
+    smartsheet_enums
+    smartsheet_types
+    smartsheet_exceptions
+
+Smartsheet Python SDK Documentation
+===================================
+
+* Release v\ |version|
+
+* `GitHub repository <https://github.com/smartsheet/smartsheet-python-sdk>`_
+
+* `Changelog <https://github.com/smartsheet/smartsheet-python-sdk/blob/mainline/CHANGELOG.md>`_
+
+Installation
+------------
+
+To install using pip::
+
+    pip install smartsheet-python-sdk
+
+Quickstart
+----------
+
+Getting started is easy:
+
+#.  Get your Smartsheet API access token. Find out more about getting
+    `direct API access <https://developers.smartsheet.com/api/smartsheet/guides/getting-started>`_ in the Smartsheet API Documentation.
+    You can generate an access token in Smartsheet UI under Account > Personal Settings > API Access.
+
+#.  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".
+
+#.  Import the smartsheet module and start using the SDK (see examples below).
+
+Authentication
+--------------
+
+You can authenticate with the Smartsheet API in two ways:
+
+**Option 1: Environment Variable (Recommended)**
+
+Set the **SMARTSHEET_ACCESS_TOKEN** environment variable::
+
+    export SMARTSHEET_ACCESS_TOKEN="your_token_here"
+
+Then create the client without parameters::
+
+    import smartsheet
+    smart = smartsheet.Smartsheet()
+
+**Option 2: Direct Token**
+
+Pass the access token directly to the Smartsheet constructor::
+
+    import smartsheet
+    smart = smartsheet.Smartsheet(access_token='your_token_here')
+
+Example Usage
+-------------
+
+Basic Example
+~~~~~~~~~~~~~
+
+The following example shows how to create a Smartsheet client and perform some basic operations::
+
+    import smartsheet
+
+    # Create a Smartsheet client (uses SMARTSHEET_ACCESS_TOKEN environment variable)
+    smart = smartsheet.Smartsheet()
+
+    # Or create with explicit token:
+    # smart = smartsheet.Smartsheet(access_token='your_token_here')
+
+    # List all sheets
+    response = smart.Sheets.list_sheets()
+
+    # Get the ID of the first sheet
+    sheet_id = response.data[0].id
+
+    # Load the sheet by using its ID
+    sheet = smart.Sheets.get_sheet(sheet_id)
+
+    # Print information about the sheet
+    print(f"The sheet {sheet.name} has {sheet.total_row_count} rows")
+
+Working with Rows
+~~~~~~~~~~~~~~~~~
+
+Add rows to a sheet::
+
+    import smartsheet
+
+    smart = smartsheet.Smartsheet()
+
+    # Build new row
+    new_row = smart.models.Row()
+    new_row.to_top = True
+    new_row.cells.append({
+        'column_id': 123456789,
+        'value': 'New Value'
+    })
+
+    # Add rows to sheet
+    response = smart.Sheets.add_rows(sheet_id, [new_row])
+
+Working with Cells
+~~~~~~~~~~~~~~~~~~
+
+Update cell values::
+
+    import smartsheet
+
+    smart = smartsheet.Smartsheet()
+
+    # Build new cell value
+    new_cell = smart.models.Cell()
+    new_cell.column_id = 123456789
+    new_cell.value = 'Updated Value'
+    new_cell.strict = False
+
+    # Build the row to update
+    new_row = smart.models.Row()
+    new_row.id = 987654321
+    new_row.cells.append(new_cell)
+
+    # Update rows
+    response = smart.Sheets.update_rows(sheet_id, [new_row])
+
+Additional Resources
+--------------------
+
+For more examples and detailed documentation:
+
+* `Smartsheet Python SDK sample project <https://github.com/smartsheet-samples/python-read-write-sheet>`_
+* `Smartsheet API Documentation <https://developers.smartsheet.com/api/smartsheet/introduction>`_ for dozens of Python SDK usage examples