Merge pull request #17 from sassoftware/dev

Merge Dev

Author: Jon Walker

CHANGELOG.md

@@ -3,7 +3,14 @@ Unreleased
 ----------
  **Improvements**
 - Added `update_module` and `delete_module` methods to MAS service.
- 
+
+**Changed**
+- Added `replace` parameter to `sasctl.tasks.publish_model` 
+- `Session` hostname's can now be specified in HTTP format: 'http://example.com'.
+
+**Bugfixes**
+- Renamed `microanalytic_store` service to `microanalytic_score` 
+
 
 v1.0.1 (2019-07-31)
 -------------------

CONTRIBUTING.md

@@ -31,15 +31,13 @@ integration testing without requiring a running SAS Viya environment, the
 [Betamax](https://pypi.org/project/betamax/) package is used to record and
 replay network interactions.
 
-In addition, [Tox](https://tox.readthedocs.io) is used to test 
-compatibility with different Python version.
+In addition, [Tox](https://tox.readthedocs.io) is used to automate common development tasks
+such as testing, linting, and building documentation.
 
 All packages required for development and testing are listed in
-[test_requirements.txt](test_requirements.txt) and can be easily installed with
-```
-pip install -r test_requirements.txt
-``` 
-
+[tox.ini](tox.ini), but it should be unecessary to install these manually.  Running `tox`
+from the project root directory will automatically build virtual environments for all
+Python interpreters found on the system and then install the required packages in those environments.
 
 Before a pull request will be accepted:
 - contributions must pass existing regression tests located in tests/

doc/api/services/microanalytic_store.rst renamed to doc/api/services/microanalytic_score.rst

@@ -1,7 +1,7 @@
-sasctl.services.microanalytic\_store
+sasctl.services.microanalytic\_score
 ====================================
 
-.. automodule:: sasctl._services.microanalytic_store
+.. automodule:: sasctl._services.microanalytic_score
     :members:
     :undoc-members:
     :show-inheritance:

doc/conf.py

@@ -54,7 +54,8 @@
                        'betamax': ('https://betamax.readthedocs.io/en/latest/', None),
                        'requests': (
                            'https://2.python-requests.org/en/master/', None),
-                       'tox': ('https://tox.readthedocs.io/en/latest/', None)}
+                       'tox': ('https://tox.readthedocs.io/en/latest/', None),
+                       'flake8': ('http://flake8.pycqa.org/en/latest/', None)}
 
 todo_include_todos = True
 

doc/index.rst

@@ -33,11 +33,7 @@ If not already present, these packages will be downloaded and install automatica
 The following additional packages are recommended for full functionality:
 
 - swat
-
-
-All required and recommended packages are listed in `requirements.txt` and can be installed easily with::
-
-    pip install -r requirements.txt
+- kerberos
 
 
 Installation
@@ -47,10 +43,14 @@ For basic functionality::
 
     pip install sasctl
 
-For full functionality::
 
+Functionality that depends on additional packages can be installed using the following::
+
+    pip install sasctl[swat]
+    pip install sasctl[kerberos]
     pip install sasctl[all]
 
+
 Quickstart
 ----------
 
@@ -347,7 +347,8 @@ simple code examples that demonstrate how to use various features are always wel
 
 
 All documentation is contained in the :file:`doc/` directory of the source repository and is written in `reStructuredText`_.
-The .rst files are then processed by `Sphinx`_ to produce the final documentation.
+The .rst files are then processed by `Sphinx`_ to produce the final documentation.  See the :ref:`tox_commands` section for
+details on how to build the final documentation.
 
 .. _`reStructuredText`: http://docutils.sourceforge.net/rst.html
 .. _`Sphinx`: http://www.sphinx-doc.org/en/master/
@@ -370,11 +371,13 @@ the copyright to your contribution, this simply gives us permission to use and r
 part of the project.
 
 1. Fork the repository
-#. Ensure you're environment has the necessary packages:
+#. Run all unit and integration tests and ensure they pass.  This can be easily accomplished by running the following:
+
+  :command:`tox`
 
-  :command:`pip install -r test_requirements.txt`
+  See :ref:`tox_commands` for more information on using Tox.
 
-3. Run all unit and integration tests and ensure they pass.  If any tests fail, you should investigate and correct the failure *before* making any changes.
+3. If any tests fail, you should investigate and correct the failure *before* making any changes.
 #. Make your code changes
 #. Include new tests that validate your changes
 #. Rerun all unit and integration tests and ensure they pass.
@@ -388,6 +391,8 @@ All code submissions must meet the following requirements before the pull reques
 
 .. _`numpydoc`: https://numpydoc.readthedocs.io/en/latest/format.html
 
+
+
 .. _testing:
 
 Testing
@@ -416,6 +421,63 @@ And finally, the :doc:`tox <tox:index>` module is used to ensure that **sasctl**
 Python versions.
 
 
+.. _tox_commands:
+
+Useful Tox Commands
++++++++++++++++++++
+:mod:`tox`  is used to automate common development tasks such as testing, linting, and building documentation.
+Running :program:`tox` from the project root directory will automatically build virtual environments for all Python interpreters
+found on the system and then install the required packages necessary to perform a given task.  The simplest way to run Tox is:
+
+.. code::
+
+   $ tox
+
+This will run the :mod:`flake8` linter followed by :mod:`pytest` to test the code against all Python runtimes
+found on the machine.  One of the great features of Tox is the ability to run specific tasks by specifying the environment to run.
+A few useful environments are listed below, where **XX** indicates a Python version present in your development environment,
+such as '27' or '36'.
+
+#.
+   .. code::
+
+      $ tox -e pyXX-flake8
+
+   Runs the flake8 linter against all **sasctl** source code.
+
+#.
+   .. code::
+
+      $ tox -e pyXX-flake8 src/sasctl/tasks.py
+
+   Runs the flake8 linter against a specific file.
+
+#.
+   .. code::
+
+      $ tox -e pyXX-tests
+
+   Runs all tests using the specified Python interpreter.
+
+#.
+   .. code::
+
+      $ tox -e pyXX-doc
+
+   Builds the documentation.
+
+#.
+   .. code::
+
+      $ tox -e pyXX-tests -- python
+
+   Starts a Python REPL in an environment with **sasctl** already installed.
+
+For additional information on configuring and using Tox, see the official :doc:`documentation <tox:index>` or Sean Hammond's excellent `tutorial`_.
+
+.. _`tutorial`: https://seanh.cc/post/tox-tutorial/
+
+
 Release History
 ---------------
 

requirements.txt

@@ -4,7 +4,7 @@
 # Copyright © 2019, SAS Institute Inc., Cary, NC, USA.  All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
 
-__version__ = '1.0.1'
+__version__ = '1.1.0'
 __author__ = 'SAS'
 __credits__ = ['Yi Jian Ching, Lucas De Paula, Peter Tobac, Chris Toth, Jon '
                'Walker']

src/sasctl/__init__.py

@@ -4,24 +4,33 @@
 # Copyright © 2019, SAS Institute Inc., Cary, NC, USA.  All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
 
+"""Enables publishing objects such as models to various destinations."""
+
 import re
 
 from .service import Service
+from .model_repository import ModelRepository
 
 
 class ModelPublish(Service):
-    """The Model Publish API provides support for publishing objects (such as
-    models) to CAS, Hadoop, SAS Micro Analytic Service, or Teradata.
+    """Enables publishing objects such as models to various destinations.
+
+    The service provides methods for managing publish destinations like CAS,
+    Hadoop, Teradata, or SAS Micro Analytic Service
     """
+
     _SERVICE_ROOT = '/modelPublish'
+    _model_repository = ModelRepository()
 
     @staticmethod
     def _publish_name(name):
         """Create a valid module name from an input string.
 
-        Model Publishing only permits names that adhere to the following restrictions:
+        Model Publishing only permits names that adhere to the following
+        restrictions:
             - Name must start with a letter or an underscore.
-            - Name may not contain any spaces or special characters other than underscore.
+            - Name may not contain any spaces or special characters other than
+              underscore.
 
         Parameters
         ----------
@@ -30,8 +39,8 @@ def _publish_name(name):
         Returns
         -------
         str
-        """
 
+        """
         # Remove all non-word characters
         name = re.sub(r'[^\w]', '', str(name))
 
@@ -41,31 +50,53 @@ def _publish_name(name):
 
         return name
 
-    def list_models(self):
-        return self.get('/models').get('items', [])
+    @classmethod
+    def list_models(cls):
+        return cls.get('/models').get('items', [])
 
-    def list_destinations(self):
-        return self.get('/destinations').get('items', [])
+    list_destinations, get_destination, update_destination, \
+        delete_destination = Service._crud_funcs('/destinations',
+                                                 'destination')
 
-    def publish_model(self, model, destination, name=None, code=None,
+    @classmethod
+    def publish_model(cls, model, destination, name=None, code=None,
                       notes=None):
+        """
 
+        Parameters
+        ----------
+        model : str or dict
+            The name or id of the model, or a dictionary representation of
+            the model.
+        destination : str or dict
+            The name or id of the publishing destination, or a dictionary
+            representation of the destination
+        name : str, optional
+            Name of the published model.  Defaults to the model name.
+        code : str, optional
+            The code to be published.
+        notes
+
+        Returns
+        -------
+
+        """
         code_types = {
             'ds2package': 'ds2',
             'datastep': 'datastep',
             '': ''
         }
 
-        model = services.model_repository.get_model(model)
-        model_uri = services.model_repository.get_model_link(model, 'self')
+        model = cls._model_repository.get_model(model)
+        model_uri = cls._model_repository.get_model_link(model, 'cls')
 
         # Get score code from registry if no code specified
         if code is None:
-            code_link = services.model_repository.get_model_link(model,
-                                                                 'scoreCode',
-                                                                 True)
+            code_link = cls._model_repository.get_model_link(model,
+                                                             'scoreCode',
+                                                             True)
             if code_link:
-                code = get(code_link['href'])
+                code = cls.get(code_link['href'])
 
         request = dict(
             name=name or model.get('name'),
@@ -84,7 +115,6 @@ def publish_model(self, model, destination, name=None, code=None,
         }
 
         request['modelContents'] = [modelContents]
-        return self.post('/models', json=request, headers={
-            'Content-Type': 'application/vnd.sas.models.publishing.request+json'})
-
-
+        return cls.post('/models', json=request, headers={
+            'Content-Type':
+                'application/vnd.sas.models.publishing.request+json'})