Merge master commits into refactorPZMM

Author: smlindauer

.conda/meta.yaml

@@ -0,0 +1,45 @@
+{% set data = load_setup_py_data(setup_file='../setup.py', from_recipe_dir=True) %}
+{% set name = "sasctl" %}
+{% set version = data.get('version') %}
+
+package:
+  name: {{ name|lower }}
+  version: {{ data.version }}
+
+source:
+  path: ..
+
+build:
+  entry_points:
+    - sasctl = sasctl.utils.cli:main
+  noarch: python
+  script: {{ PYTHON }} -m pip install . -vv
+  number: 0
+
+requirements:
+  host:
+    - python >=3.6
+    - pip
+  run:
+    - python >=3.6
+    - pandas
+    - requests
+    - pyyaml
+    - packaging
+
+test:
+  imports:
+    - sasctl
+  commands:
+    - pip check
+    - sasctl --help
+  requires:
+    - pip
+
+about:
+  home: https://github.com/sassoftware/python-sasctl/
+  summary: "Python package and CLI for user-friendly integration with SAS Viya"
+  license: Apache-2.0
+  license_file: LICENSE
+  doc_url: https://sassoftware.github.io/python-sasctl/
+  dev_url: https://github.com/sassoftware/python-sasctl/

.github/workflows/build-test-deploy.yml

@@ -118,11 +118,12 @@ jobs:
           name: html-docs
           path: ./docs/_build/html
 
-  build:
-    name: "Build Package"
+  # Build a package for distribution through PyPI.org (pip install sasctl)
+  build_pypi:
+    name: "Build PyPI Package"
     runs-on: ubuntu-latest
     needs: test
-    if: startsWith(github.ref, 'refs/tags/') # run only on tagged commits
+    if: startsWith(github.ref, 'refs/tags/')  # run only on tagged commits
 
     steps:
       - name: Checkout repository
@@ -158,38 +159,74 @@ jobs:
 
       - name: Archive distribution artifacts
         # Archive distribution files for use by auto (or manual) PyPI upload
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: pypi-dist
           path: ./dist
 
       - name: Archive changelog artifacts
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: release_notes
           path: release_notes.md
 
+  # Build a package for distribution through Anaconda.org (conda install sasctl)
+  build_conda:
+    name: "Build Conda Package"
+    runs-on: ubuntu-latest
+    needs: test
+    if: startsWith(github.ref, 'refs/tags/') # run only on tagged commits
+
+    steps:
+      # Setup Miniconda
+      - uses: conda-incubator/setup-miniconda@v2
+        with:
+          auto-update-conda: true
+
+      - name: Install conda-build
+        shell: bash -l {0}
+        run: |
+          conda install conda-build
+
+      - name: Checkout repository
+        uses: actions/checkout@v3
 
+      # Build package and store results in .build folder
+      - name: Build package
+        shell: bash -l {0}
+        run: |
+          conda build --output-folder .build .conda
+
+      # Archive distribution files.  Will upload in a downstream job.
+      - name: Archive distribution artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: conda-dist
+          path: .build
+
+
+  # Publishes the new package to PyPI, uploads the latest documentation to GitHub Pages
+  # and creates a new release with change notes on GitHub.
   publish:
     name: "Publish"
     runs-on: ubuntu-latest
-    needs: [gh-pages, build]
-    steps:
+    needs: [gh-pages, build_pypi, build_conda]
 
+    steps:
       - name: Download documentation
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v3
         with:
           name: html-docs
           path: ./html-docs
 
       - name: Download release
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v3
         with:
           name: pypi-dist
           path: ./dist
 
       - name: Download release notes
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v3
         with:
           name: release_notes
 
@@ -199,6 +236,7 @@ jobs:
       - name: Display structure of downloaded files
         run: ls -R
 
+      # Create a draft release on GitHub
       - name: Create Release
         id: create_release
         uses: softprops/action-gh-release@v1
@@ -208,6 +246,7 @@ jobs:
           body: ""
           files: documentation.zip
 
+      # Publish the documentation to GitHub Pages
       - name: Deploy documentation
         uses: peaceiris/actions-gh-pages@v3
         with:
@@ -221,10 +260,45 @@ jobs:
           password: ${{ secrets.PYPI_API_TOKEN }}
           verbose: true
 
+      # Publish the release on GitHub (remove draft status)
       - name: Publish release
         uses: StuYarrow/publish-release@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           id: ${{ steps.create_release.outputs.id }}
 
+
+  # Uploads the package to Anaconda.
+  # NOTE: could be merged with `publish` job above.  Left as a separate, final job since it
+  #       involves multiple steps to setup the environment and if this job fails, the package
+  #       has already been made available through pip, and the release info published.
+  upload_conda:
+    name: "Upload Conda Package"
+    runs-on: ubuntu-latest
+    needs: [publish]
+
+    steps:
+      # Setup Miniconda
+      - uses: conda-incubator/setup-miniconda@v2
+        with:
+          auto-update-conda: true
+
+      # Setup Anaconda client (required for upload)
+      - name: Install anaconda client
+        shell: bash -l {0}
+        run: |
+          conda install anaconda-client
+
+      # Download release files
+      - name: Download release
+        uses: actions/download-artifact@v3
+        with:
+          name: conda-dist
+          path: ./dist
+
+      # Upload release to Anaconda.org
+      - name: Upload release
+        shell: bash -l {0}
+        run: |
+          anaconda -t ${{ secrets.ANACONDA_TOKEN }} upload -u sas-institute ./dist/noarch/sasctl-*.tar.bz2

CHANGELOG.md

@@ -1,6 +1,20 @@
 Unreleased
 ----------
- -
+**Bugfixes**
+ - Fixed an issue where invalid HTTP responses could cause an error when using `Session.version_info()`.
+ 
+v1.8.2 (2023-01-30)
+-------------------
+**Improvements**
+ - `folders.get_folder()` can now handle folder paths and delegates (e.g. @public).
+
+**Bugfixes**
+ - Fixed an issue with `model_management.execute_model_workflow_definition()` where input values for
+   workflow prompts were not correctly submitted.  Note that the `input=` parameter was renamed to
+   `prompts=` to avoid conflicting with the built-in `input()`.
+ - Fixed an issue with `pzmm.importModel.model_exists()` where project versions were incorrectly
+   compared, resulting in improper behavior when the project version already existed.
+   - Better handling for invalid project versions included.
 
 v1.8.1 (2023-01-19)
 ----------

README.md

@@ -47,7 +47,7 @@
 The sasctl package enables easy communication between the SAS Viya 
 platform and a Python runtime. It can be used as a module or as a command line interface.
 ```
-sasctl.folders.list_folders()
+sasctl.services.folders.list_folders()
 ```
 
 ```
@@ -89,6 +89,10 @@ install the latest source code:
 
 ```pip install git+https://github.com/sassoftware/python-sasctl```
 
+Alternatively, if you're using Anaconda you can install with:
+```
+conda install -c sas-institute sasctl
+```
 
 ## Getting Started
 

src/sasctl/__init__.py

@@ -4,7 +4,7 @@
 # Copyright © 2019, SAS Institute Inc., Cary, NC, USA.  All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
 
-__version__ = "1.8.1"
+__version__ = "1.8.2"
 __author__ = "SAS"
 __credits__ = [
     "Yi Jian Ching",

src/sasctl/_services/folders.py

@@ -19,7 +19,7 @@ class Folders(Service):
 
     _SERVICE_ROOT = "/folders"
 
-    list_folders, get_folder, update_folder, delete_folder = Service._crud_funcs(
+    list_folders, _get_folder, update_folder, delete_folder = Service._crud_funcs(
         "/folders", "folder"
     )
 
@@ -62,3 +62,76 @@ def create_folder(cls, name, parent=None, description=None):
             params={"parentFolderUri": parent_uri},
             headers={"Content-Type": "application/vnd.sas.content.folder+json"},
         )
+
+    @classmethod
+    def get_folder(cls, folder, refresh=False):
+        """Return a folder instance.
+
+        Parameters
+        ----------
+        folder : str or dict
+            May be one of:
+             - folder name
+             - folder ID
+             - folder path
+             - folder delegate string
+             - dictionary representation of the folder
+        refresh : bool, optional
+            Obtain an updated copy of the folder.
+
+        Returns
+        -------
+        RestObj or None
+            A dictionary containing the folder attributes or None.
+
+        Notes
+        -------
+        If `folder` is a complete representation of the folder it will be
+        returned unless `refresh` is set.  This prevents unnecessary REST
+        calls when data is already available on the client.
+
+        Examples
+        --------
+        The following four examples are all functionally equivalent.
+
+        >>> get_folder("Public")
+        {"name": "Public", "id": "4a737209-5662"}
+
+        >>> get_folder("/Public")
+        {"name": "Public", "id": "4a737209-5662"}
+
+        >>> get_folder("@public")
+        {"name": "Public", "id": "4a737209-5662"}
+
+        >>> get_folder("@public")
+        {"name": "Public", "id": "4a737209-5662"}
+
+        >>> get_folder("4a737209-5662")
+        {"name": "Public", "id": "4a737209-5662"}
+
+        The full folder path can also be specified.
+
+        >>> get_folder("/Public/Demo")
+        {"name": "Demo", "id": "148081bf-1c86"}
+
+        Special folders can be identified using a delegate string.  Currently supported
+        are: @myFolder, @appDataFolder, @myHistory, @myFavorites, and @public.
+
+        >>> get_folder("@myFolder")
+        {"name": "My Folder", "id": "71687cd2-db4b"}
+
+        """
+        # If a folder path is specified, lookup folder using the full path instead of the name.
+        if isinstance(folder, str) and "/" in folder:
+            # Path must include a leading "/"
+            if not folder.startswith("/"):
+                folder = f"/{folder}"
+
+            return cls.get("/folders/@item", params={"path": folder})
+
+        # Its possible to lookup special folders by using a handle (called a delegate string in docs)
+        # Current values (2022.09) are @myFolder, @appDataFolder, @myHistory, @myFavorites, @public.
+        if isinstance(folder, str) and folder.startswith("@"):
+            return cls.get(f"/folders/{folder}")
+
+        return cls._get_folder(folder, refresh=refresh)