flywheel-sdk 21.3.0__py3-none-any.whl → 21.4.0__py3-none-any.whl

flywheel/models/gear_manifest.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 
@@ -88,7 +81,45 @@ class GearManifest(object):
     }
 
     def __init__(self, name=None, inputs=None, config=None, custom=None, author=None, maintainer='', cite='', capabilities=None, description=None, environment=None, command='bash -c ./run', license=None, label=None, url=None, source=None, version=None, flywheel=None, output_configuration=None):  # noqa: E501
-        """GearManifest - a model defined in Swagger"""
+        """GearManifest - a model defined in Swagger
+
+        :param name:, defaults to None
+        :type name: str, optional
+        :param inputs:, defaults to None
+        :type inputs: dict(str, union[GearFileInput,GearContextInput,GearKeyInput]), optional
+        :param config:, defaults to None
+        :type config: object, optional
+        :param custom:, defaults to None
+        :type custom: object, optional
+        :param author:, defaults to None
+        :type author: str, optional
+        :param maintainer:, defaults to ''
+        :type maintainer: str, optional
+        :param cite:, defaults to ''
+        :type cite: str, optional
+        :param capabilities:, defaults to None
+        :type capabilities: list[str], optional
+        :param description:, defaults to None
+        :type description: str, optional
+        :param environment:, defaults to None
+        :type environment: dict(str, str), optional
+        :param command:, defaults to 'bash -c ./run'
+        :type command: str, optional
+        :param license:, defaults to None
+        :type license: str, optional
+        :param label:, defaults to None
+        :type label: str, optional
+        :param url:, defaults to None
+        :type url: str, optional
+        :param source:, defaults to None
+        :type source: str, optional
+        :param version:, defaults to None
+        :type version: str, optional
+        :param flywheel:, defaults to None
+        :type flywheel: dict(str, object), optional
+        :param output_configuration:, defaults to None
+        :type output_configuration: GearOutputConfiguration, optional
+        """
         super(GearManifest, self).__init__()
 
         self._name = None
@@ -147,7 +178,7 @@ class GearManifest(object):
         """Gets the name of this GearManifest.
 
 
-        :return: The name of this GearManifest.
+        :return: The name of this GearManifest
         :rtype: str
         """
         return self._name
@@ -157,8 +188,8 @@ class GearManifest(object):
         """Sets the name of this GearManifest.
 
 
-        :param name: The name of this GearManifest.  # noqa: E501
-        :type: str
+        :param name: The name of this GearManifest
+        :type name: str
         """
 
         self._name = name
@@ -168,7 +199,7 @@ class GearManifest(object):
         """Gets the inputs of this GearManifest.
 
 
-        :return: The inputs of this GearManifest.
+        :return: The inputs of this GearManifest
         :rtype: dict(str, union[GearFileInput,GearContextInput,GearKeyInput])
         """
         return self._inputs
@@ -178,8 +209,8 @@ class GearManifest(object):
         """Sets the inputs of this GearManifest.
 
 
-        :param inputs: The inputs of this GearManifest.  # noqa: E501
-        :type: dict(str, union[GearFileInput,GearContextInput,GearKeyInput])
+        :param inputs: The inputs of this GearManifest
+        :type inputs: dict(str, union[GearFileInput,GearContextInput,GearKeyInput])
         """
 
         self._inputs = inputs
@@ -189,7 +220,7 @@ class GearManifest(object):
         """Gets the config of this GearManifest.
 
 
-        :return: The config of this GearManifest.
+        :return: The config of this GearManifest
         :rtype: object
         """
         return self._config
@@ -199,8 +230,8 @@ class GearManifest(object):
         """Sets the config of this GearManifest.
 
 
-        :param config: The config of this GearManifest.  # noqa: E501
-        :type: object
+        :param config: The config of this GearManifest
+        :type config: object
         """
 
         self._config = config
@@ -210,7 +241,7 @@ class GearManifest(object):
         """Gets the custom of this GearManifest.
 
 
-        :return: The custom of this GearManifest.
+        :return: The custom of this GearManifest
         :rtype: object
         """
         return self._custom
@@ -220,8 +251,8 @@ class GearManifest(object):
         """Sets the custom of this GearManifest.
 
 
-        :param custom: The custom of this GearManifest.  # noqa: E501
-        :type: object
+        :param custom: The custom of this GearManifest
+        :type custom: object
         """
 
         self._custom = custom
@@ -231,7 +262,7 @@ class GearManifest(object):
         """Gets the author of this GearManifest.
 
 
-        :return: The author of this GearManifest.
+        :return: The author of this GearManifest
         :rtype: str
         """
         return self._author
@@ -241,8 +272,8 @@ class GearManifest(object):
         """Sets the author of this GearManifest.
 
 
-        :param author: The author of this GearManifest.  # noqa: E501
-        :type: str
+        :param author: The author of this GearManifest
+        :type author: str
         """
 
         self._author = author
@@ -252,7 +283,7 @@ class GearManifest(object):
         """Gets the maintainer of this GearManifest.
 
 
-        :return: The maintainer of this GearManifest.
+        :return: The maintainer of this GearManifest
         :rtype: str
         """
         return self._maintainer
@@ -262,8 +293,8 @@ class GearManifest(object):
         """Sets the maintainer of this GearManifest.
 
 
-        :param maintainer: The maintainer of this GearManifest.  # noqa: E501
-        :type: str
+        :param maintainer: The maintainer of this GearManifest
+        :type maintainer: str
         """
 
         self._maintainer = maintainer
@@ -273,7 +304,7 @@ class GearManifest(object):
         """Gets the cite of this GearManifest.
 
 
-        :return: The cite of this GearManifest.
+        :return: The cite of this GearManifest
         :rtype: str
         """
         return self._cite
@@ -283,8 +314,8 @@ class GearManifest(object):
         """Sets the cite of this GearManifest.
 
 
-        :param cite: The cite of this GearManifest.  # noqa: E501
-        :type: str
+        :param cite: The cite of this GearManifest
+        :type cite: str
         """
 
         self._cite = cite
@@ -294,7 +325,7 @@ class GearManifest(object):
         """Gets the capabilities of this GearManifest.
 
 
-        :return: The capabilities of this GearManifest.
+        :return: The capabilities of this GearManifest
         :rtype: list[str]
         """
         return self._capabilities
@@ -304,8 +335,8 @@ class GearManifest(object):
         """Sets the capabilities of this GearManifest.
 
 
-        :param capabilities: The capabilities of this GearManifest.  # noqa: E501
-        :type: list[str]
+        :param capabilities: The capabilities of this GearManifest
+        :type capabilities: list[str]
         """
 
         self._capabilities = capabilities
@@ -315,7 +346,7 @@ class GearManifest(object):
         """Gets the description of this GearManifest.
 
 
-        :return: The description of this GearManifest.
+        :return: The description of this GearManifest
         :rtype: str
         """
         return self._description
@@ -325,8 +356,8 @@ class GearManifest(object):
         """Sets the description of this GearManifest.
 
 
-        :param description: The description of this GearManifest.  # noqa: E501
-        :type: str
+        :param description: The description of this GearManifest
+        :type description: str
         """
 
         self._description = description
@@ -336,7 +367,7 @@ class GearManifest(object):
         """Gets the environment of this GearManifest.
 
 
-        :return: The environment of this GearManifest.
+        :return: The environment of this GearManifest
         :rtype: dict(str, str)
         """
         return self._environment
@@ -346,8 +377,8 @@ class GearManifest(object):
         """Sets the environment of this GearManifest.
 
 
-        :param environment: The environment of this GearManifest.  # noqa: E501
-        :type: dict(str, str)
+        :param environment: The environment of this GearManifest
+        :type environment: dict(str, str)
         """
 
         self._environment = environment
@@ -357,7 +388,7 @@ class GearManifest(object):
         """Gets the command of this GearManifest.
 
 
-        :return: The command of this GearManifest.
+        :return: The command of this GearManifest
         :rtype: str
         """
         return self._command
@@ -367,8 +398,8 @@ class GearManifest(object):
         """Sets the command of this GearManifest.
 
 
-        :param command: The command of this GearManifest.  # noqa: E501
-        :type: str
+        :param command: The command of this GearManifest
+        :type command: str
         """
 
         self._command = command
@@ -378,7 +409,7 @@ class GearManifest(object):
         """Gets the license of this GearManifest.
 
 
-        :return: The license of this GearManifest.
+        :return: The license of this GearManifest
         :rtype: str
         """
         return self._license
@@ -388,8 +419,8 @@ class GearManifest(object):
         """Sets the license of this GearManifest.
 
 
-        :param license: The license of this GearManifest.  # noqa: E501
-        :type: str
+        :param license: The license of this GearManifest
+        :type license: str
         """
 
         self._license = license
@@ -399,7 +430,7 @@ class GearManifest(object):
         """Gets the label of this GearManifest.
 
 
-        :return: The label of this GearManifest.
+        :return: The label of this GearManifest
         :rtype: str
         """
         return self._label
@@ -409,8 +440,8 @@ class GearManifest(object):
         """Sets the label of this GearManifest.
 
 
-        :param label: The label of this GearManifest.  # noqa: E501
-        :type: str
+        :param label: The label of this GearManifest
+        :type label: str
         """
 
         self._label = label
@@ -420,7 +451,7 @@ class GearManifest(object):
         """Gets the url of this GearManifest.
 
 
-        :return: The url of this GearManifest.
+        :return: The url of this GearManifest
         :rtype: str
         """
         return self._url
@@ -430,8 +461,8 @@ class GearManifest(object):
         """Sets the url of this GearManifest.
 
 
-        :param url: The url of this GearManifest.  # noqa: E501
-        :type: str
+        :param url: The url of this GearManifest
+        :type url: str
         """
 
         self._url = url
@@ -441,7 +472,7 @@ class GearManifest(object):
         """Gets the source of this GearManifest.
 
 
-        :return: The source of this GearManifest.
+        :return: The source of this GearManifest
         :rtype: str
         """
         return self._source
@@ -451,8 +482,8 @@ class GearManifest(object):
         """Sets the source of this GearManifest.
 
 
-        :param source: The source of this GearManifest.  # noqa: E501
-        :type: str
+        :param source: The source of this GearManifest
+        :type source: str
         """
 
         self._source = source
@@ -462,7 +493,7 @@ class GearManifest(object):
         """Gets the version of this GearManifest.
 
 
-        :return: The version of this GearManifest.
+        :return: The version of this GearManifest
         :rtype: str
         """
         return self._version
@@ -472,8 +503,8 @@ class GearManifest(object):
         """Sets the version of this GearManifest.
 
 
-        :param version: The version of this GearManifest.  # noqa: E501
-        :type: str
+        :param version: The version of this GearManifest
+        :type version: str
         """
 
         self._version = version
@@ -483,7 +514,7 @@ class GearManifest(object):
         """Gets the flywheel of this GearManifest.
 
 
-        :return: The flywheel of this GearManifest.
+        :return: The flywheel of this GearManifest
         :rtype: dict(str, object)
         """
         return self._flywheel
@@ -493,8 +524,8 @@ class GearManifest(object):
         """Sets the flywheel of this GearManifest.
 
 
-        :param flywheel: The flywheel of this GearManifest.  # noqa: E501
-        :type: dict(str, object)
+        :param flywheel: The flywheel of this GearManifest
+        :type flywheel: dict(str, object)
         """
 
         self._flywheel = flywheel
@@ -504,7 +535,7 @@ class GearManifest(object):
         """Gets the output_configuration of this GearManifest.
 
 
-        :return: The output_configuration of this GearManifest.
+        :return: The output_configuration of this GearManifest
         :rtype: GearOutputConfiguration
         """
         return self._output_configuration
@@ -514,8 +545,8 @@ class GearManifest(object):
         """Sets the output_configuration of this GearManifest.
 
 
-        :param output_configuration: The output_configuration of this GearManifest.  # noqa: E501
-        :type: GearOutputConfiguration
+        :param output_configuration: The output_configuration of this GearManifest
+        :type output_configuration: GearOutputConfiguration
         """
 
         self._output_configuration = output_configuration

flywheel/models/gear_mixin.py

@@ -116,7 +116,16 @@ class GearMixin(object):
                 default_config[key] = value.get("default")
         return default_config
 
-    def run(self, config=None, analysis_label=None, tags=None, destination=None, inputs=None, priority=None, **kwargs):
+    def run(
+        self,
+        config=None,
+        analysis_label=None,
+        tags=None,
+        destination=None,
+        inputs=None,
+        priority=None,
+        **kwargs,
+    ):
         """Run the gear.
 
         :param dict config: The configuration to use, if overriding defaults.
@@ -124,6 +133,7 @@ class GearMixin(object):
         :param list tags: The list of tags to set for the job.
         :param object destination: The destination container.
         :param dict inputs: The list of input containers or files.
+        :param str priority: The priority for the gear run.
 
         :return: The id of the job that was created (utility gear) or of the analysis container created (analysis gear).
         """
@@ -186,15 +196,26 @@ class GearMixin(object):
         return self._invoke_gear_api("get_gear_series")
 
     def add_permission(self, permission_type, permission_id):
-        """Add individual permission to gear."""
+        """Add an individual permission to gear.
+
+        :param GearPermissionsType permisson_type: The type of permission to add.
+        :param str permission_id: The permission ID to add.
+        """
         return self._invoke_gear_api("add_gear_permission", permission_type, permission_id)
 
     def replace_permissions(self, permissions):
-        """Replace gear permissions."""
+        """Replace the existing gear permissions.
+
+        :param GearPermissions permissions: The new permissions to set for the gear.
+        """
         return self._invoke_gear_api("replace_gear_permissions", permissions)
 
     def delete_permission(self, permission_type, permission_id):
-        """Delete individual permission by type and id"""
+        """Delete an individual permission by type and id.
+
+        :param GearPermissionsType permisson_type: The type of permission to delete.
+        :param str permission_id: The permission ID to delete.
+        """
         self._invoke_gear_api("delete_gear_permission", permission_type, permission_id)
 
     def delete_all_permissions(self):
@@ -205,8 +226,7 @@ class GearMixin(object):
         self._invoke_gear_api("delete_gear_permissions")
 
     def modify_gear_series(self, gear_series_update):
-        """
-        Modify the gear series attributes such as `is_restricted`
+        """Modify the gear series attributes such as `is_restricted`.
 
         :param GearSeriesUpdate gear_series_update: the dictionary specifying
             the updates to make to the gear series

flywheel/models/gear_node.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 
@@ -63,7 +56,25 @@ class GearNode(GearMixin):
     }
 
     def __init__(self, container_type=None, category=None, gear=None, exchange=None, created=None, modified=None, disabled=None, id=None):  # noqa: E501
-        """GearNode - a model defined in Swagger"""
+        """GearNode - a model defined in Swagger
+
+        :param container_type:, defaults to None
+        :type container_type: str, optional
+        :param category:, defaults to None
+        :type category: GearCategory, optional
+        :param gear:, defaults to None
+        :type gear: GearManifest, optional
+        :param exchange:, defaults to None
+        :type exchange: GearExchange, optional
+        :param created:, defaults to None
+        :type created: datetime, optional
+        :param modified:, defaults to None
+        :type modified: datetime, optional
+        :param disabled:, defaults to None
+        :type disabled: datetime, optional
+        :param id:, defaults to None
+        :type id: str, optional
+        """
         super(GearNode, self).__init__()
 
         self._container_type = None
@@ -93,7 +104,7 @@ class GearNode(GearMixin):
         """Gets the container_type of this GearNode.
 
 
-        :return: The container_type of this GearNode.
+        :return: The container_type of this GearNode
         :rtype: str
         """
         return self._container_type
@@ -103,8 +114,8 @@ class GearNode(GearMixin):
         """Sets the container_type of this GearNode.
 
 
-        :param container_type: The container_type of this GearNode.  # noqa: E501
-        :type: str
+        :param container_type: The container_type of this GearNode
+        :type container_type: str
         """
 
         self._container_type = container_type
@@ -114,7 +125,7 @@ class GearNode(GearMixin):
         """Gets the category of this GearNode.
 
 
-        :return: The category of this GearNode.
+        :return: The category of this GearNode
         :rtype: GearCategory
         """
         return self._category
@@ -124,8 +135,8 @@ class GearNode(GearMixin):
         """Sets the category of this GearNode.
 
 
-        :param category: The category of this GearNode.  # noqa: E501
-        :type: GearCategory
+        :param category: The category of this GearNode
+        :type category: GearCategory
         """
 
         self._category = category
@@ -135,7 +146,7 @@ class GearNode(GearMixin):
         """Gets the gear of this GearNode.
 
 
-        :return: The gear of this GearNode.
+        :return: The gear of this GearNode
         :rtype: GearManifest
         """
         return self._gear
@@ -145,8 +156,8 @@ class GearNode(GearMixin):
         """Sets the gear of this GearNode.
 
 
-        :param gear: The gear of this GearNode.  # noqa: E501
-        :type: GearManifest
+        :param gear: The gear of this GearNode
+        :type gear: GearManifest
         """
 
         self._gear = gear
@@ -156,7 +167,7 @@ class GearNode(GearMixin):
         """Gets the exchange of this GearNode.
 
 
-        :return: The exchange of this GearNode.
+        :return: The exchange of this GearNode
         :rtype: GearExchange
         """
         return self._exchange
@@ -166,8 +177,8 @@ class GearNode(GearMixin):
         """Sets the exchange of this GearNode.
 
 
-        :param exchange: The exchange of this GearNode.  # noqa: E501
-        :type: GearExchange
+        :param exchange: The exchange of this GearNode
+        :type exchange: GearExchange
         """
 
         self._exchange = exchange
@@ -177,7 +188,7 @@ class GearNode(GearMixin):
         """Gets the created of this GearNode.
 
 
-        :return: The created of this GearNode.
+        :return: The created of this GearNode
         :rtype: datetime
         """
         return self._created
@@ -187,8 +198,8 @@ class GearNode(GearMixin):
         """Sets the created of this GearNode.
 
 
-        :param created: The created of this GearNode.  # noqa: E501
-        :type: datetime
+        :param created: The created of this GearNode
+        :type created: datetime
         """
 
         self._created = created
@@ -198,7 +209,7 @@ class GearNode(GearMixin):
         """Gets the modified of this GearNode.
 
 
-        :return: The modified of this GearNode.
+        :return: The modified of this GearNode
         :rtype: datetime
         """
         return self._modified
@@ -208,8 +219,8 @@ class GearNode(GearMixin):
         """Sets the modified of this GearNode.
 
 
-        :param modified: The modified of this GearNode.  # noqa: E501
-        :type: datetime
+        :param modified: The modified of this GearNode
+        :type modified: datetime
         """
 
         self._modified = modified
@@ -219,7 +230,7 @@ class GearNode(GearMixin):
         """Gets the disabled of this GearNode.
 
 
-        :return: The disabled of this GearNode.
+        :return: The disabled of this GearNode
         :rtype: datetime
         """
         return self._disabled
@@ -229,8 +240,8 @@ class GearNode(GearMixin):
         """Sets the disabled of this GearNode.
 
 
-        :param disabled: The disabled of this GearNode.  # noqa: E501
-        :type: datetime
+        :param disabled: The disabled of this GearNode
+        :type disabled: datetime
         """
 
         self._disabled = disabled
@@ -240,7 +251,7 @@ class GearNode(GearMixin):
         """Gets the id of this GearNode.
 
 
-        :return: The id of this GearNode.
+        :return: The id of this GearNode
         :rtype: str
         """
         return self._id
@@ -250,8 +261,8 @@ class GearNode(GearMixin):
         """Sets the id of this GearNode.
 
 
-        :param id: The id of this GearNode.  # noqa: E501
-        :type: str
+        :param id: The id of this GearNode
+        :type id: str
         """
 
         self._id = id