Merge pull request #25 from sassoftware/dev

v1.2.0

Author: Jon Walker

.gitignore

@@ -21,6 +21,7 @@
 .ipynb_checkpoints
 .tags
 *.iml
+_scratch
 
 ## Python files
 # setup.py working directory
@@ -60,3 +61,4 @@ Thumbs.db
 doc/build
 doc/source/generated
 doc/_build
+doc/.doctrees

CHANGELOG.md

@@ -1,20 +1,28 @@
 
 Unreleased
 ----------
+**Improvements**
+- Added `create_model_version` and `list_model_versions` to `model_repository`
+- Added an explicit `ValueError` when attempting to register an ASTORE that can't be downloaded.
+- Added `start` and `limit` pagination parameters to all default `list_*` service methods.
+- Added `create_destination`, `create_cas_destination` and `create_mas_destination` methods for `model_publish` service.
+
+**Changes**
+- `Session.add_stderr_logger` default logging level changed to `DEBUG`.
+
+**Bugfixes**
+- Fixed an issue where `model_repository` did not find models, projects, or repositories by name once pagination limits were reached. 
+
 
- - 
- 
 v1.1.4 (2019-8-16)
 -----------------
-
 **Bugfixes**
  - The `register_model` task now generates dmcas_epscorecode.sas files for ASTORE models.
 
 
 v1.1.3 (2019-8-14)
 -----------------
-
-**Bugfixes**
+ **Bugfixes**
  - Fixed problem causing `register_model` task to include output variables in the input variables list.
 
 

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.1.4'
+__version__ = '1.2.0'
 __author__ = 'SAS'
 __credits__ = ['Yi Jian Ching, Lucas De Paula, James Kochuba, Peter Tobac, '
                'Chris Toth, Jon Walker']

src/sasctl/_services/model_publish.py

@@ -8,8 +8,8 @@
 
 import re
 
-from .service import Service
 from .model_repository import ModelRepository
+from .service import Service
 
 
 class ModelPublish(Service):
@@ -59,9 +59,13 @@ def list_models(cls):
                                                  'destination')
 
     @classmethod
-    def publish_model(cls, model, destination, name=None, code=None,
+    def publish_model(cls,
+                      model,
+                      destination,
+                      name=None,
+                      code=None,
                       notes=None):
-        """
+        """Publish a model to an existing publishing destination.
 
         Parameters
         ----------
@@ -118,3 +122,150 @@ def publish_model(cls, model, destination, name=None, code=None,
         return cls.post('/models', json=request, headers={
             'Content-Type':
                 'application/vnd.sas.models.publishing.request+json'})
+
+    @classmethod
+    def create_cas_destination(cls, name,
+                               library,
+                               table,
+                               server=None,
+                               description=None):
+        """Define a new CAS publishing destination.
+
+        Parameters
+        ----------
+        name : str
+            Name of the publishing destination.
+        library : str
+            The CAS library in which `table` will be stored.
+        table : str
+            Name of the CAS table in which models will be stored.
+        server : str, optional
+            Name of the CAS server.  Defaults to 'cas-shared-default'.
+        description : str, optional
+            Description of the publishing destination.
+
+        Returns
+        -------
+        RestObj
+
+        """
+        server = server or 'cas-shared-default'
+
+        return cls.create_destination(name, cas_server=server,
+                                      cas_library=library, cas_table=table,
+                                      type_='cas', description=description)
+
+    @classmethod
+    def create_mas_destination(cls, name, uri, description=None):
+        """Define a new Micro Analytic Server (MAS) publishing destination.
+
+        Parameters
+        ----------
+        name : str
+            Name of the publishing destination.
+        uri : str
+            The base URI that contains the host, the protocol, and optionally
+            the port, which addresses the remote SAS Micro Analytic Service to
+            use.  Example: http://spam.com
+        description : str, optional
+            Description of the publishing destination.
+
+        Returns
+        -------
+        RestObj
+
+        """
+        return cls.create_destination(name, mas_uri=uri, type_='mas',
+                                      description=description)
+
+    @classmethod
+    def create_destination(cls,
+                           name,
+                           type_,
+                           cas_server=None,
+                           cas_library=None,
+                           cas_table=None,
+                           description=None,
+                           mas_uri=None,
+                           hdfs_dir=None,
+                           conf_dir=None,
+                           user=None,
+                           database_library=None):
+        """Define a new publishing destination.
+
+        Parameters
+        ----------
+        name : str
+            Name of the publishing destination.
+        type_ : {'cas', 'mas', 'hadoop', 'teradata'}
+            Type of publishing definition being created
+        cas_server : str, optional
+            Name of the CAS server.  Defaults to 'cas-shared-default'.
+            Required if `type_` is 'cas', otherwise ignored.
+        cas_library : str, optional
+            The CAS library in which `cas_table` will be stored.  Required if
+            `type_` is 'cas', otherwise ignored.
+        cas_table : str, optional
+            Name of the CAS table in which models will be stored.  Required
+            if `type_` is 'cas', otherwise ignored.
+        description : str, optional
+            Description of the publishing destination.
+        mas_uri : str, optional
+            Required if `type_` is 'mas', otherwise ignored.
+        hdfs_dir : str, optional
+            Required if `type_` is 'hadoop', otherwise ignored.
+        conf_dir : str, optional
+            Required if `type_` is 'hadoop', otherwise ignored.
+        user : str, optional
+            Required if `type_` is 'hadoop', otherwise ignored.
+        database_library : str, optional
+            Required if `type_` is 'teradata', otherwise ignored.
+
+        Returns
+        -------
+        RestObj
+
+        """
+        type_ = str(type_).lower()
+        assert type_ in ('cas', 'microanalyticservice', 'mas',
+                         'teradata', 'hadoop')
+
+        # As of Viya 3.4 capitalization matters.
+        if type_ in ('microanalyticservice', 'mas'):
+            type_ = 'microAnalyticService'
+
+        request = {'name': str(name),
+                   'destinationType': type_,
+                   'casServerName': cas_server,
+                   'casLibrary': cas_library,
+                   'description': description,
+                   'destinationTable': cas_table,
+                   'databaseCasLibrary': database_library,
+                   'user': user,
+                   'hdfsDirectory': hdfs_dir,
+                   'configurationDirectory': conf_dir,
+                   'masUri': mas_uri
+                   }
+
+        drop_list = {
+            'cas':
+                ('databaseCasLibrary', 'user', 'hdfsDirectory', 'masUri',
+                 'configurationDirectory'),
+            'microAnalyticService':
+                ('casServerName', 'casLibrary', 'destinationTable', 'user',
+                 'databaseCasLibrary', 'hdfsDirectory',
+                 'configurationDirectory'),
+            'hadoop':
+                ('casServerName', 'casLibrary', 'destinationTable',
+                 'databaseCasLibrary', 'masUri'),
+            'teradata':
+                ('casServerName', 'casLibrary', 'destinationTable', 'user',
+                 'hdfsDirectory', 'masUri', 'configurationDirectory')
+        }
+
+        for k in drop_list[request['destinationType']]:
+            request.pop(k, None)
+
+        return cls.post('/destinations', json=request, headers={
+            'Content-Type':
+                'application/vnd.sas.models.publishing.destination+json'})