smartsheet-python-sdk 3.0.3__tar.gz → 3.0.5__tar.gz

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.5}/.github/ISSUE_TEMPLATE/bug_report.md

@@ -27,5 +27,6 @@ If applicable, add screenshots to help explain your problem.
 
 **Environment (please complete the following information):**
  - OS: [e.g. Windows 10]
+ - Smartsheet API Version [e.g. 2.0]
  - Smartsheet Python SDK Version [e.g. 3.0.0]
  - Python Version [e.g. 3.10]

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.5}/.github/ISSUE_TEMPLATE/feature_request.md

@@ -15,3 +15,9 @@ A clear and concise description of what you want to happen.
 
 **Additional context**
 Add any other context or screenshots about the feature request here.
+
+**Environment (please complete the following information):**
+ - OS: [e.g. Windows 10]
+ - Smartsheet API Version [e.g. 2.0]
+ - Smartsheet Python SDK Version [e.g. 3.0.0]
+ - Python Version [e.g. 3.10]

smartsheet-python-sdk-3.0.5/.github/pull_request_template.md

@@ -0,0 +1,43 @@
+# Pull Request
+
+## Description
+<!-- Provide a brief description of the changes in this PR -->
+
+## Related Issue
+<!-- Link to the related issue (if applicable) -->
+
+## Type of Change
+<!-- Check the relevant option by putting an x in the brackets -->
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Documentation update
+- [ ] Code refactoring
+- [ ] Other (please describe):
+
+## Environment Information
+<!-- Please complete the following information -->
+- Smartsheet API Version: [e.g. 2.0]
+- Smartsheet Python SDK Version: [e.g. 3.0.0]
+- Python Version: [e.g. 3.10]
+
+## What Changes Were Made
+<!-- Describe the changes you've made in detail -->
+
+## Why These Changes Were Made
+<!-- Explain the reasoning behind these changes -->
+
+## Testing
+<!-- Describe the testing you've done to validate your changes -->
+
+## Checklist
+<!-- Check all that apply -->
+- [ ] My code follows the [style guidelines](../../../CONTRIBUTING.md#code-style-and-quality) of this project
+- [ ] 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
+- [ ] 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
+
+## Additional Notes
+<!-- Add any other context about the PR here -->

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.5}/.github/workflows/publish-distribution.yaml

@@ -9,19 +9,19 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python 3.10
         uses: actions/setup-python@v4
         with:
           python-version: '3.10'
       - name: Install build packages
         run: |
-          pip install enum34 requests six python-dateutil setuptools-scm gitchangelog mako wheel twine sphinx sphinx_rtd_theme
+          pip install enum34 requests six python-dateutil setuptools-scm==7.1.0 gitchangelog mako wheel twine sphinx sphinx_rtd_theme
       - name: Build distribution
         run: |
           python setup.py sdist bdist_wheel
       - name: Archive distribution artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: distribution
           path: dist

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.5}/.github/workflows/publish-documentation.yaml

@@ -9,14 +9,14 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python 3.10
         uses: actions/setup-python@v4
         with:
           python-version: '3.10'
       - name: Install build packages
         run: |
-          pip install enum34 requests six python-dateutil setuptools-scm gitchangelog mako wheel twine sphinx sphinx_rtd_theme
+          pip install enum34 requests six python-dateutil setuptools-scm==7.1.0 gitchangelog mako wheel twine sphinx sphinx_rtd_theme
       - name: Generate documentation
         run: |
           sphinx-apidoc -o docs-source smartsheet
@@ -40,4 +40,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v1
+        uses: actions/deploy-pages@v4

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.5}/.github/workflows/test-build.yaml

@@ -6,7 +6,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
@@ -24,17 +24,27 @@ jobs:
 
   mock-api-test:
     needs: lint
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     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
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
         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
@@ -65,19 +75,17 @@ jobs:
     runs-on: ubuntu-latest
     needs: [mock-api-test]
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python ${{ matrix.python-version }}
+      - uses: actions/checkout@v4
+      - name: Set up Python
         uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
       - name: Install build packages
         run: |
-          pip install enum34 requests six python-dateutil setuptools-scm gitchangelog mako wheel twine 
+          pip install enum34 requests six python-dateutil setuptools-scm==7.1.0 gitchangelog mako wheel twine 
       - name: Build distribution
         run: |
           python setup.py sdist bdist_wheel
       - name: Archive distribution artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: distribution
           path: dist
@@ -87,7 +95,7 @@ jobs:
     runs-on: ubuntu-latest
     needs: [build-packages-test]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install documentation tools
         run: |
           pip install sphinx sphinx_rtd_theme setuptools-scm
@@ -96,7 +104,7 @@ jobs:
       - name: Generate HTML
         run: sphinx-build -b html -d docs-source/_build/doctrees docs-source/. docs-source/_build/html
       - name: Upload artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: html-docs
           path: docs/build/html/

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.5}/ADVANCED.md

@@ -115,6 +115,13 @@ start consuming events. The `since` parameter can be set with a datetime value t
 (e.g. 2010-01-01T00:00:00Z) or as UNIX epoch (in which case the `numeric_dates` parameter must also be set to `True`.
 By default the `numeric_dates` parameter is set to `False`).
 
+The sample utilizes the `smartsheet_client.Events.list_events` method to request a list of events up to a certain
+point in the stream. The `to` parameter specifies the endpoint in time (i.e., event occurrence datetime) in the stream
+up to which events should be retrieved. This `to` parameter can be assigned a datetime value formatted either as
+ISO 8601 (e.g., 2020-12-31T23:59:59Z) or as UNIX epoch time, in which case the numeric_dates parameter must be set to True.
+If not specified, the `numeric_dates` parameter defaults to `False`, assuming the datetime is in ISO 8601 format.
+This allows for precise control over the range of events to be fetched, facilitating efficient data retrieval and processing.
+
 To consume the next list of events after the initial list of events is returned, set the `stream_position` parameter
 with the `next_stream_position` property obtained from the previous request and don't set the `since` parameter with
 any values. This is because when using the `list_events` method, either the `since` parameter or the `stream_position`

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.5}/CHANGELOG.md

@@ -5,6 +5,24 @@ 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.0.5] - 2025-04-07
+
+### Changed
+
+- Fallback filename for `DownloadedFile` when `Content-Disposition` header is missing.
+
+## [3.0.4] - 2024-07-29
+
+### Changed
+
+- Changed `serialize` function to also handle dicts - this allows the Event Reporting API to
+  return the `additionalDetails` object correctly
+
+### Added
+
+- `to` parameter added for Event Reporting - allows setting an end timestamp for filtering for
+  events
+
 ## [3.0.3] - 2024-07-17
 
 ### Fixed

smartsheet-python-sdk-3.0.5/CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# Contributing to Smartsheet Python SDK
+
+## Did you find a bug?
+
+- **Send all security related bugs to our maintainer email, <sdk-python@smartsheet.com>**.
+
+- **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/smartsheet/smartsheet-python-sdk/issues).
+
+- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/smartsheet/smartsheet-python-sdk/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **[MRE code sample](https://stackoverflow.com/help/minimal-reproducible-example)** or an **executable test case** demonstrating the expected behavior that is not occurring. If possible please also note if this issue concerns the API itself or just the Python SDK.
+
+## Did you write a patch that fixes a bug?
+
+- Open a new GitHub pull request with the patch.
+
+- Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
+
+- A maintainer should review your PR within the next few days. If the PR has been dormant for more than a week, consider sending an email to <sdk-python@smartsheet.com>
+
+## Did you fix whitespace, format code, or make a purely cosmetic patch?
+
+Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability may take longer to review, but are still welcome.
+
+## Do you intend to add a new feature or change an existing one?
+
+- Suggest your change as an issue with the label #enhancement. Make sure that your new feature description outlines why this would be helpful for users, and how difficult a change it would be to make.
+
+## Code Style and Quality
+
+- Follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guidelines for Python code.
+
+- Use meaningful variable and function names that clearly describe their purpose.
+
+- Include docstrings for all public modules, functions, classes, and methods following [PEP 257](https://www.python.org/dev/peps/pep-0257/) conventions.
+
+- Run pylint on your code before submitting a PR. The project includes a pylintrc file with project-specific settings.
+
+- Write unit tests for new features and bug fixes. All tests should pass before submitting a PR.
+
+## Running Tests
+
+- To run the test suite, use the following command:
+
+  ```bash
+  python -m pytest tests/
+  ```
+
+- For integration tests, you'll need to set up your Smartsheet API access token as an environment variable:
+
+  ```bash
+  export SMARTSHEET_ACCESS_TOKEN=your_token_here
+  ```
+
+## Do you have questions about the source code or using the SDK?
+
+- For general information on the API and its uses, see the [Smartsheet API Reference](https://smartsheet.redoc.ly/)
+
+- For information on the Python SDK, see the [Smartsheet Python SDK Documentation](https://github.com/smartsheet/smartsheet-python-sdk#readme) or review the [basic](https://github.com/smartsheet/smartsheet-python-sdk#readme) and [advanced](https://github.com/smartsheet/smartsheet-python-sdk/blob/master/ADVANCED.md) READMEs!
+
+- Github issues can also be used for questions on using the Python SDK specifically.
+
+Thanks!
+
+Smartsheet Python SDK Team

{smartsheet-python-sdk-3.0.3/smartsheet_python_sdk.egg-info → smartsheet-python-sdk-3.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: smartsheet-python-sdk
-Version: 3.0.3
+Version: 3.0.5
 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

smartsheet-python-sdk-3.0.5/pylintrc

@@ -0,0 +1,14 @@
+[MASTER]
+jobs=0
+
+[MESSAGES CONTROL]
+disable=missing-docstring,too-many-arguments,too-many-positional-arguments,locally-disabled,too-few-public-methods,too-many-public-methods,duplicate-code,too-many-instance-attributes,too-many-lines,no-else-return,unused-private-member,cyclic-import,unused-import,import-outside-toplevel,consider-using-with
+
+[REPORTS]
+output-format=colorized
+
+[BASIC]
+include-naming-hint=yes
+
+[FORMAT]
+max-line-length=160

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.5}/setup.py

@@ -63,7 +63,7 @@ setup(
     use_scm_version={
         'write_to': 'smartsheet/version.py'
     },
-    setup_requires=['setuptools_scm'],
+    setup_requires=['setuptools_scm==7.0.1'],
     install_requires=REQUIRES,
     packages=find_packages(),
     include_package_data=True,

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.5}/smartsheet/cells.py

@@ -55,6 +55,7 @@ class Cells:
             page (int): Which page to return.
             include_all (bool): If true, include all results
                 (i.e. do not paginate).
+            level (int): compatibility level
 
         Returns:
             IndexResult

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.5}/smartsheet/events.py

@@ -30,13 +30,19 @@ class Events:
         self._log = logging.getLogger(__name__)
 
     def list_events(
-        self, since=None, stream_position=None, max_count=None, numeric_dates=None
+        self, since=None, to=None, stream_position=None, max_count=None, numeric_dates=None # pylint: disable=invalid-name
     ):
         """Get the list of all Events.
 
         Args:
             since (str or long): Starting time for events to return.
                 You must pass in a value for either since or streamPosition and never both.
+            to (str or long): Ending time for events to return.
+                This parameter specifies the endpoint in time for the events to be fetched.
+                Similar to the `since` parameter, `to` can be passed in either as a datetime string in
+                ISO 8601 format or as a UNIX epoch time in milliseconds. This allows for defining a
+                precise time range for the events query. Note that `to` is optional and can be used in
+                conjunction with `since` to specify both the start and end times for the event retrieval window.
             stream_position (str): Indicates next set of events to return.
                 Use value of nextStreamPosition returned from the previous call.
                 You must pass in a value for either since or streamPosition and never both.
@@ -53,9 +59,14 @@ class Events:
         _op["method"] = "GET"
         _op["path"] = "/events"
         if isinstance(since, datetime):
-            _op["query_params"]["since"] = since  # .isoformat()
+            _op["query_params"]["since"] = since.isoformat()
         else:
             _op["query_params"]["since"] = since
+
+        if isinstance(to, datetime):
+            _op["query_params"]["to"] = to.isoformat()
+        else:
+            _op["query_params"]["to"] = to
         _op["query_params"]["streamPosition"] = stream_position
         _op["query_params"]["maxCount"] = max_count
         _op["query_params"]["numericDates"] = numeric_dates

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.5}/smartsheet/reports.py

@@ -69,6 +69,7 @@ class Reports:
             include (list[str]): A comma-separated list of
                 optional elements to include in the response. Valid list values:
                 attachments, discussions, format, objectValue, scope, source, sourceSheets.
+            level (int): compatibility level
 
         Returns:
             Report

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.5}/smartsheet/sheets.py

@@ -534,6 +534,7 @@ class Sheets:
             page (int): Which page to return.
             if_version_after (int): only fetch Sheet if more recent version
                 available.
+            level (int): compatibility level
             rows_modified_since: Date should be in ISO-8601 format, for example, rowsModifiedSince=2020-01-30T13:25:32-07:00.
             filter_id (int): Applies the given filter (if accessible by the calling user)
                 and marks the affected rows as "filteredOut": true
@@ -1620,6 +1621,7 @@ class Sheets:
         Args:
             sheet_id (int): Sheet ID
             sort_specifier_obj (SortSpecifier): SortSpecifier object
+            level (int): compatibility level
 
         Returns:
             Sheet

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.5}/smartsheet/smartsheet.py

@@ -520,9 +520,25 @@ class OperationResult:
             if expected != "DownloadedFile":
                 data = self.resp.json()
             else:
-                filename = re.findall(
-                    'filename="(.+)";', self.resp.headers["Content-Disposition"]
-                )
+                # default
+                filename = ["download"]
+
+                if "Content-Disposition" in self.resp.headers:
+                    # use the provided filename
+                    filename = re.findall(
+                        'filename="(.+)";', self.resp.headers["Content-Disposition"]
+                    )
+                else:
+                    content_type = self.resp.headers.get("Content-Type", "")
+                    if content_type in [
+                        "application/vnd.ms-excel",
+                        "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+                    ]:
+                        filename[0] += ".xlsx"
+                    elif content_type == "application/pdf":
+                        filename[0] += ".pdf"
+                    elif content_type == "text/csv":
+                        filename[0] += ".csv"
 
                 data = {
                     "resultCode": 0,

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.5}/smartsheet/util.py

@@ -112,6 +112,14 @@ def serialize(obj):
                 serialized = serialize(item)
                 if not hasattr(serialized, "is_explicit_null"):
                     retval.append(serialized)
+
+    elif isinstance(obj, dict):
+        retval = {}
+        for key, value in obj.items():
+            serialized_value = serialize(value)
+            if not hasattr(serialized_value, "is_explicit_null"):
+                retval[key] = serialized_value
+
     else:
         retval = {}
         prop_list = get_child_properties(obj)

smartsheet-python-sdk-3.0.5/smartsheet/version.py

@@ -0,0 +1,4 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+__version__ = version = '3.0.5'
+__version_tuple__ = version_tuple = (3, 0, 5)

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.5/smartsheet_python_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: smartsheet-python-sdk
-Version: 3.0.3
+Version: 3.0.5
 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

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.5}/smartsheet_python_sdk.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@
 .markdownlint.json
 ADVANCED.md
 CHANGELOG.md
+CONTRIBUTING.md
 LICENSE.md
 Makefile
 NOTICE
@@ -11,6 +12,7 @@ README.md
 pylintrc
 setup.cfg
 setup.py
+.github/pull_request_template.md
 .github/ISSUE_TEMPLATE/bug_report.md
 .github/ISSUE_TEMPLATE/feature_request.md
 .github/workflows/publish-distribution.yaml

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.5}/tests/integration/test_events.py

@@ -3,7 +3,6 @@ import six
 from datetime import datetime, timedelta
 import smartsheet
 
-
 @pytest.mark.usefixtures("smart_setup")
 class TestEvents:
 
@@ -11,7 +10,9 @@ class TestEvents:
         smart = smart_setup['smart']
 
         last_hour = datetime.now() - timedelta(hours=1)
-        events_list = smart.Events.list_events(since=last_hour.isoformat(), max_count=10)
+        current_time = datetime.now()
+
+        events_list = smart.Events.list_events(since=last_hour.isoformat(), to=current_time.isoformat(), max_count=10)
         assert isinstance(events_list, smart.models.EventResult)
         assert len(events_list.data) <= 10
         for event in events_list.data:
@@ -24,6 +25,8 @@ class TestEvents:
             assert event.request_user_id is not None
             # assert event.access_token_name is not None
             assert event.source.value is not None
+            if event.additional_details is not None:
+                assert isinstance(event.additional_details, dict)
 
         while events_list.more_available:
             events_list = smart.Events.list_events(stream_position=events_list.next_stream_position, max_count=10,
@@ -40,6 +43,8 @@ class TestEvents:
                 assert event.request_user_id is not None
                 # assert event.access_token_name is not None
                 assert event.source.value is not None
+                if event.additional_details is not None:
+                    assert isinstance(event.additional_details, dict)
 
     def test_invalid_params(self, smart_setup):
         smart = smart_setup['smart']

smartsheet-python-sdk-3.0.3/pylintrc

@@ -1,11 +0,0 @@
-[MASTER]
-jobs=0
-
-[MESSAGES CONTROL]
-disable=missing-docstring,too-many-arguments,locally-disabled,too-few-public-methods,too-many-public-methods,duplicate-code,too-many-instance-attributes,too-many-lines,no-else-return,unused-private-member,cyclic-import,unused-import,import-outside-toplevel,consider-using-with
-
-[REPORTS]
-output-format=colorized
-
-[BASIC]
-include-naming-hint=yes

smartsheet-python-sdk-3.0.3/smartsheet/version.py

@@ -1,16 +0,0 @@
-# file generated by setuptools_scm
-# don't change, don't track in version control
-TYPE_CHECKING = False
-if TYPE_CHECKING:
-    from typing import Tuple, Union
-    VERSION_TUPLE = Tuple[Union[int, str], ...]
-else:
-    VERSION_TUPLE = object
-
-version: str
-__version__: str
-__version_tuple__: VERSION_TUPLE
-version_tuple: VERSION_TUPLE
-
-__version__ = version = '3.0.3'
-__version_tuple__ = version_tuple = (3, 0, 3)