Miinor python doc fixes/improvements

Author: Agathe Guillemot

dataikuapi/dss/apideployer.py

@@ -60,7 +60,7 @@ def list_stages(self):
         """
         Lists infrastructure stages of the API Deployer
 
-        :rtype: a list of dict. Each dict contains a field "id" for the stage identifier and "desc" for its description.
+        :rtype: list of dict. Each dict contains a field "id" for the stage identifier and "desc" for its description.
         :rtype: list
         """
         return self.client._perform_json("GET", "/api-deployer/stages")
@@ -167,7 +167,7 @@ def get_status(self):
         """
         Returns status information about this infrastructure
 
-        :rtype: a :class:`dataikuapi.dss.apideployer.DSSAPIDeployerInfraStatus`
+        :rtype: :class:`dataikuapi.dss.apideployer.DSSAPIDeployerInfraStatus`
         """
         light = self.client._perform_json("GET", "/api-deployer/infras/%s" % (self.infra_id))
 
@@ -272,6 +272,7 @@ def list_deployments(self):
     def get_raw(self):
         """
         Gets the raw status information. This returns a dictionary with various information about the infrastructure
+
         :rtype: dict
         """
         return self.light_status
@@ -295,7 +296,8 @@ def id(self):
         return self.deployment_id
 
     def get_status(self):
-        """Returns status information about this deployment
+        """
+        Returns status information about this deployment
 
         :rtype: dataikuapi.dss.apideployer.DSSAPIDeployerDeploymentStatus
         """
@@ -341,7 +343,8 @@ def delete(self):
 
 
 class DSSAPIDeployerDeploymentSettings(object):
-    """The settings of an API Deployer deployment. 
+    """
+    The settings of an API Deployer deployment. 
 
     Do not create this directly, use :meth:`~dataikuapi.dss.apideployer.DSSAPIDeployerDeployment.get_settings`
     """
@@ -360,7 +363,9 @@ def get_raw(self):
         return self.settings
 
     def set_enabled(self, enabled):
-        """Enables or disables this deployment"""
+        """
+        Enables or disables this deployment
+        """
         self.settings["enabled"] = enabled
 
     def set_single_version(self, version):
@@ -375,14 +380,17 @@ def set_single_version(self, version):
         }
 
     def save(self):
-        """Saves back these settings to the deployment"""
+        """
+        Saves back these settings to the deployment
+        """
         self.client._perform_empty(
                 "PUT", "/api-deployer/deployments/%s/settings" % (self.deployment_id),
                 body = self.settings)
 
 
 class DSSAPIDeployerDeploymentStatus(object):
-    """The status of an API Deployer deployment. 
+    """
+    The status of an API Deployer deployment. 
 
     Do not create this directly, use :meth:`~dataikuapi.dss.apideployer.DSSAPIDeployerDeployment.get_status`
     """
@@ -404,12 +412,15 @@ def get_light(self):
     def get_heavy(self):
         """
         Gets the 'heavy' (full) status. This returns a dictionary with various information about the deployment
+
         :rtype: dict
         """
         return self.heavy_status
 
     def get_service_urls(self):
-        """Returns service-level URLs for this deployment (ie without the enpdoint-specific suffix)"""
+        """
+        Returns service-level URLs for this deployment (ie without the enpdoint-specific suffix)
+        """
 
         if "deployedServiceId" in self.light_status["deploymentBasicInfo"]:
             service_id = self.light_status["deploymentBasicInfo"]["deployedServiceId"]
@@ -424,7 +435,8 @@ def get_service_urls(self):
             raise ValueError("PublicURL not available for this deployment. It might still be initializing")
 
     def get_health(self):
-        """Returns the health of this deployment as a string
+        """
+        Returns the health of this deployment as a string
 
         :returns: HEALTHY if the deployment is working properly, various other status otherwise
         :rtype: string
@@ -491,6 +503,7 @@ def get_settings(self):
     def delete_version(self, version):
         """
         Deletes a version from this service
+
         :param string version: The version to delete
         """
         self.client._perform_empty(
@@ -507,7 +520,8 @@ def delete(self):
 
 
 class DSSAPIDeployerServiceSettings(object):
-    """The settings of an API Deployer Service. 
+    """
+    The settings of an API Deployer Service. 
 
     Do not create this directly, use :meth:`~dataikuapi.dss.apideployer.DSSAPIDeployerService.get_settings`
     """
@@ -526,14 +540,17 @@ def get_raw(self):
         return self.settings
 
     def save(self):
-        """Saves back these settings to the API service"""
+        """
+        Saves back these settings to the API service
+        """
         self.client._perform_empty(
                 "PUT", "/api-deployer/services/%s/settings" % (self.service_id),
                 body = self.settings)
 
 
 class DSSAPIDeployerServiceStatus(object):
-    """The status of an API Deployer Service. 
+    """
+    The status of an API Deployer Service. 
 
     Do not create this directly, use :meth:`~dataikuapi.dss.apideployer.DSSAPIDeployerService.get_status`
     """
@@ -556,6 +573,7 @@ def get_versions(self):
     def get_raw(self):
         """
         Gets the raw status information. This returns a dictionary with various information about the service,
+
         :rtype: dict
         """
         return self.light_status

dataikuapi/dss/project.py

@@ -958,7 +958,8 @@ def get_exported_bundle_archive_stream(self, bundle_id):
     def download_exported_bundle_archive_to_file(self, bundle_id, path):
         """
         Download a bundle archive that can be deployed in a DSS automation Node into the given output file.
-        @param path if "-", will write to /dev/stdout
+        
+        :param path if "-", will write to /dev/stdout
         """
         if path == "-":
             path= "/dev/stdout"
@@ -974,6 +975,7 @@ def download_exported_bundle_archive_to_file(self, bundle_id, path):
     def publish_bundle(self, bundle_id, published_project_key=None):
         """
         Publish a bundle on the Project Deployer.
+
         :param string bundle_id: The identifier of the bundle
         :param string published_project_key: The key of the project on the Project Deployer where the bundle will be published.
             A new published project will be created if none matches the key.

dataikuapi/dss/projectdeployer.py

@@ -69,7 +69,7 @@ def list_stages(self):
         """
         Lists infrastructure stages of the Project Deployer
 
-        :rtype: a list of dict. Each dict contains a field "id" for the stage identifier and "desc" for its description.
+        :rtype: list of dict. Each dict contains a field "id" for the stage identifier and "desc" for its description.
         :rtype: list
         """
         return self.client._perform_json("GET", "/project-deployer/stages")
@@ -156,6 +156,7 @@ def upload_bundle(self, fp, project_key=None):
         """
         Uploads a new version for a project from a file-like object pointing
         to a bundle Zip file.
+
         :param string fp: A file-like object pointing to a bundle Zip file
         :param string project_key: The key of the published project where the bundle will be uploaded. If the project does not exist, it is created.
         If not set, the key of the bundle's source project is used.
@@ -193,7 +194,7 @@ def get_status(self):
         """
         Returns status information about this infrastructure
 
-        :rtype: a :class:`dataikuapi.dss.projectdeployer.DSSProjectDeployerInfraStatus`
+        :rtype: :class:`dataikuapi.dss.projectdeployer.DSSProjectDeployerInfraStatus`
         """
         light = self.client._perform_json("GET", "/project-deployer/infras/%s" % (self.infra_id))
 
@@ -242,7 +243,9 @@ def get_raw(self):
         return self.settings
 
     def save(self):
-        """Saves back these settings to the infra"""
+        """
+        Saves back these settings to the infra
+        """
         self.client._perform_empty(
                 "PUT", "/project-deployer/infras/%s/settings" % (self.infra_id),
                 body = self.settings)
@@ -271,6 +274,7 @@ def list_deployments(self):
     def get_raw(self):
         """
         Gets the raw status information. This returns a dictionary with various information about the infrastructure
+
         :rtype: dict
         """
         return self.light_status
@@ -295,7 +299,8 @@ def id(self):
         return self.deployment_id
 
     def get_status(self):
-        """Returns status information about this deployment
+        """
+        Returns status information about this deployment
 
         :rtype: dataikuapi.dss.apideployer.DSSProjectDeployerDeploymentStatus
         """
@@ -400,20 +405,24 @@ def get_light(self):
     def get_heavy(self):
         """
         Gets the 'heavy' (full) status. This returns a dictionary with various information about the deployment
+
         :rtype: dict
         """
         return self.heavy_status
 
     def get_health(self):
-        """Returns the health of this deployment as a string
+        """
+        Returns the health of this deployment as a string
 
         :returns: HEALTHY if the deployment is working properly, various other status otherwise
         :rtype: string
         """
         return self.heavy_status["health"]
 
     def get_health_messages(self):
-        """Returns messages about the health of this deployment"""
+        """
+        Returns messages about the health of this deployment
+        """
         return self.heavy_status["healthMessages"]
 
 ###############################################
@@ -462,6 +471,7 @@ def get_settings(self):
     def delete_bundle(self, bundle_id):
         """
         Deletes a bundle from this project
+
         :param string bundle_id: The identifier of the bundle to delete
         """
         self.client._perform_empty(
@@ -497,7 +507,9 @@ def get_raw(self):
         return self.settings
 
     def save(self):
-        """Saves back these settings to the project"""
+        """
+        Saves back these settings to the project
+        """
         self.client._perform_empty(
                 "PUT", "/project-deployer/projects/%s/settings" % (self.project_key),
                 body = self.settings)
@@ -542,6 +554,7 @@ def get_bundles(self):
     def get_raw(self):
         """
         Gets the raw status information. This returns a dictionary with various information about the project
+
         :rtype: dict
         """
         return self.light_status