fusion-platform-python-sdk 1.12.2__tar.gz → 1.13.5__tar.gz

{fusion-platform-python-sdk-1.12.2/fusion_platform_python_sdk.egg-info → fusion-platform-python-sdk-1.13.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fusion-platform-python-sdk
-Version: 1.12.2
+Version: 1.13.5
 Summary: Python SDK used to interact with the Fusion Platform(r)
 Home-page: https://github.com/d-cat-support/fusion-platform-python-sdk
 Author: Digital Content Analysis Technology Ltd

{fusion-platform-python-sdk-1.12.2 → fusion-platform-python-sdk-1.13.5}/fusion_platform/__init__.py

@@ -11,8 +11,8 @@ API, and this is defined within the corresponding OpenAPI 3.0 specification, whi
 """
 
 # Do not modify the following two lines as they are maintained by the version.sh script.
-__version__ = '1.12.2'
-__version_date__ = '2024-06-11T07:57:10Z'
+__version__ = '1.13.5'
+__version_date__ = '2024-08-08T11:19:48Z'
 
 # Exclude certain sub-modules from documentation.
 # @formatter:off
@@ -102,6 +102,9 @@ FILE_TYPE_CSV = 'CSV'
 FILE_TYPE_ESRI_SHAPEFILE = 'ESRI Shapefile'
 FILE_TYPE_JPEG = 'JPEG'
 FILE_TYPE_PNG = 'PNG'
+FILE_TYPE_PDF = 'PDF'
+FILE_TYPE_GZIP = 'GZIP'
+FILE_TYPE_ZIP = 'ZIP'
 FILE_TYPE_OTHER = 'Other'
 
 # Run types.

{fusion-platform-python-sdk-1.12.2 → fusion-platform-python-sdk-1.13.5}/fusion_platform/common/utilities.py

@@ -8,9 +8,40 @@ author: Matthew Casey
 
 from datetime import date, datetime, time, timezone
 from decimal import Decimal
+import re
 from types import MappingProxyType
 
 
+def datetime_parse(string_or_blank):
+    """
+    Attempts to parse an ISO8601 datetime from a string using common formats.
+
+    Args:
+        string_or_blank: The datetime to parse, or blank.
+
+    Returns:
+        The parsed datetime or None if not parsable or blank.
+    """
+    parsed = None
+
+    if not string_blank(string_or_blank):
+        # Strip out all optional delimiters and then attempt to parse with and without the "Z".
+        stripped = re.sub(r"[:]|([-](?!((\d{2}[:]\d{2})|(\d{4}))$))", '', str(string_or_blank))
+        formats = ['%Y%m%dT%H%M%S.%f', '%Y%m%dT%H%M%S.%f%z', '%Y%m%dT%H%M%S', '%Y%m%dT%H%M%S%z']
+
+        for format in formats:
+            try:
+                parsed = datetime.strptime(stripped, format)
+                parsed = parsed.astimezone(timezone.utc) if parsed.tzinfo is None else parsed  # Assume UTC if no timezone is provided.
+            except:
+                pass
+
+            if parsed is not None:
+                break
+
+    return parsed
+
+
 def dict_nested_get(dictionary_or_value, keys, default=None):
     """
     Performs a dictionary.get(key, default) using the supplied list of keys assuming that each successive key is nested.
@@ -60,6 +91,19 @@ def json_default(value):
         return str(value)
 
 
+def string_blank(string_or_blank):
+    """
+    Checks if a string is None or blank.
+
+    Args:
+        string_or_blank: The string to check.
+
+    Returns:
+        True if the string is None, blank ("") or just made up with spaces.
+    """
+    return (string_or_blank is None) or (not bool(string_or_blank.strip()))
+
+
 def string_camel_to_underscore(string):
     """
     Converts a camel case string to underscore case.

{fusion-platform-python-sdk-1.12.2 → fusion-platform-python-sdk-1.13.5}/fusion_platform/models/data.py

@@ -44,10 +44,12 @@ class DataSchema(Schema):
     bounds = fields.List(fields.Decimal(required=True), allow_none=True, metadata={'read_only': True})  # Changed to prevent this being updated.
     file_with_preview = fields.UUID(allow_none=True, metadata={'read_only': True})  # Changed to prevent this being updated.
 
+    # Removed uploaded.
     uploaded_organisation_id = fields.UUID(allow_none=True, metadata={'read_only': True})  # Changed to prevent this being updated.
     deletable = fields.String(allow_none=True, metadata={'read_only': True})  # Changed to prevent this being updated.
 
     # Removed creator.
+
     # Removed search.
 
     class Meta:
@@ -213,7 +215,7 @@ class Data(Model):
         # Return the copy.
         return self.__class__._model_from_api_id(self._session, organisation_id=self.organisation_id, id=copy_data_id)
 
-    def _create(self, name, file_type, files, wait=False):
+    def _create(self, name, file_type, files, wait=False, **kwargs):
         """
         Attempts to create the model object with the given values. This assumes the model template has been loaded first using the _new method, and that the model
         is then created using a POST RESTful request. This assumes that the post body contains key names which include the name of the model class.
@@ -221,10 +223,11 @@ class Data(Model):
         This method is overridden to also upload the corresponding files and optionally wait for the upload and analysis to complete.
 
         Args:
-        name: The name of the data object.
-        file_type: The type of files that the data object will hold.
-        files: The list of file paths to be uploaded.
-        wait: Optionally wait for the upload and analysis to complete? Default False.
+            name: The name of the data object.
+            file_type: The type of files that the data object will hold.
+            files: The list of file paths to be uploaded.
+            wait: Optionally wait for the upload and analysis to complete? Default False.
+            kwargs: The model attributes which override those already in the template.
 
         Returns:
             The created data object.
@@ -234,7 +237,7 @@ class Data(Model):
             ModelError: if the model could not be created and validated by the Fusion Platform<sup>&reg;</sup>.
         """
         # Use the super method to create the data item with the correct attributes. This will raise an exception if anything fails.
-        super(Data, self)._create(name=name)
+        super(Data, self)._create(name=name, **kwargs)
 
         # Add each of the files, assuming that each is of the same file type, and start its upload in a thread.
         try:
@@ -341,3 +344,81 @@ class Data(Model):
             ModelError: if a model could not be loaded or validated from the Fusion Platform<sup>&reg;</sup>.
         """
         return DataFile._models_from_api_path(self._session, self._get_path(self.__class__._PATH_FILES), organisation_id=self.organisation_id)
+
+    def get_stac_collection(self, items, collection_file_name=DataFile._STAC_COLLECTION_FILE_NAME, owner=None, created_at=None, detail=None):
+        """
+        Converts the data representation into a STAC collection with the specified STAC item file names.
+
+        Args:
+            items: The list of items to be put into the collection. This should be a tuple of (STAC item, item_file_name).
+            collection_file_name: The optional collection file name.
+            owner: The optional owner of the collection. Default None.
+            created_at: Optionally when the collection was created. Default None.
+            detail: The optional collection detail as a dictionary. Default None.
+
+        Returns:
+            A tuple of the STAC collection definition as a dictionary and the collection file name used in the definition.
+        """
+        stac_extensions = []
+
+        # Form the providers.
+        provider = {
+            'name': i18n.t('fusion_platform.organisation'),
+            'roles': ['producer', 'licensor'],
+            'url': i18n.t('fusion_platform.url')
+        }
+
+        # Add in the optional processing information, if any.
+        if owner is not None:
+            provider['processing:lineage'] = owner
+
+        if created_at is not None:
+            provider['processing.datetime'] = created_at
+
+        if detail is not None:
+            provider['processing:software'] = detail
+
+        if (owner is not None) or (created_at is not None) or (detail is not None):
+            stac_extensions.append('https://stac-extensions.github.io/processing/v1.2.0/schema.json')
+
+        # Form the links.
+        links = [
+            {'rel': 'self', 'href': collection_file_name, 'type': 'application/json'},
+            {'rel': 'root', 'href': collection_file_name, 'type': 'application/json'},
+        ]
+
+        # Add in the files calculating the maximal spatial and temporal extents.
+        bbox = None
+        interval_start = None
+        interval_end = None
+
+        for item, item_file_name in items:
+            # Calculate the spatial extent.
+            item_bbox = item.get('bbox')
+
+            if (bbox is None) or (len(bbox) < 4):
+                bbox = item_bbox
+
+            if (bbox is not None) and (len(bbox) >= 4) and (item_bbox is not None) and (len(item_bbox) >= 4):
+                bbox = [min(bbox[0], item_bbox[0]), min(bbox[1], item_bbox[1]), max(bbox[2], item_bbox[2]), max(bbox[3], item_bbox[3])]
+
+            # Calculate the temporal extent.
+            item_datetime = dict_nested_get(item, ['properties', 'datetime'])
+            interval_start = item_datetime if interval_start is None else min(interval_start, item_datetime)
+            interval_end = item_datetime if interval_end is None else max(interval_end, item_datetime)
+
+            # Add in the link.
+            links.append({'rel': 'item', 'href': item_file_name, 'type': 'application/geo+json'})
+
+        # Build the STAC collection.
+        return {
+            'type': 'Collection',
+            'stac_version': '1.0.0',
+            'stac_extensions': stac_extensions,
+            'id': self.id,
+            'description': self.name,
+            'license': 'proprietary',
+            'providers': [provider],
+            'extent': {'spatial': {'bbox': [bbox]}, 'temporal': {'interval': [[interval_start, interval_end]]}},
+            'links': links
+        }, collection_file_name

{fusion-platform-python-sdk-1.12.2 → fusion-platform-python-sdk-1.13.5}/fusion_platform/models/data_file.py

@@ -8,9 +8,11 @@ author: Matthew Casey
 
 import i18n
 from marshmallow import Schema, EXCLUDE
+import os
 
+import fusion_platform
 from fusion_platform.common.raise_thread import RaiseThread
-from fusion_platform.common.utilities import dict_nested_get
+from fusion_platform.common.utilities import datetime_parse, dict_nested_get
 from fusion_platform.models import fields
 from fusion_platform.models.model import Model, ModelError
 
@@ -65,6 +67,7 @@ class DataFileSchema(Schema):
     organisation_id = fields.UUID(allow_none=True, metadata={'read_only': True, 'title': i18n.t('models.data_file.organisation_id.title'), 'description': i18n.t(
         'models.data_file.organisation_id.description')})  # Added parameter so that it can be used.
     data_id = fields.UUID(required=True, metadata={'read_only': True})  # Changed to prevent this being updated.
+    # Removed organisation_id_file_type.
 
     file_id = fields.UUID(required=True, metadata={'read_only': True})  # Changed to prevent this being updated.
     preview_file_id = fields.UUID(allow_none=True, metadata={'read_only': True})  # Changed to prevent this being updated.
@@ -120,6 +123,34 @@ class DataFile(Model):
     # Plus query parameters.
     _QUERY_PREVIEW = 'preview'
 
+    # Geospatial file types.
+    _GEOSPATIAL_RASTER = 'raster'
+    _GEOSPATIAL_VECTOR = 'vector'
+
+    # File type information - a tuple of typical extension and whether the file type is a geospatial vector, raster or not.
+    # @formatter:off
+    _FILE_TYPES = {
+        fusion_platform.FILE_TYPE_GEOTIFF: ('tif', _GEOSPATIAL_RASTER),
+        fusion_platform.FILE_TYPE_JPEG2000: ('jpeg', _GEOSPATIAL_RASTER),
+        fusion_platform.FILE_TYPE_DEM: ('dem', _GEOSPATIAL_RASTER),
+        fusion_platform.FILE_TYPE_GEOJSON: ('json', _GEOSPATIAL_VECTOR),
+        fusion_platform.FILE_TYPE_KML: ('kml', _GEOSPATIAL_VECTOR),
+        fusion_platform.FILE_TYPE_KMZ: ('kmz', _GEOSPATIAL_VECTOR),
+        fusion_platform.FILE_TYPE_CSV: ('csv', None),
+        fusion_platform.FILE_TYPE_ESRI_SHAPEFILE: ('zip', _GEOSPATIAL_VECTOR),
+        fusion_platform.FILE_TYPE_JPEG: ('jpg', None),
+        fusion_platform.FILE_TYPE_PNG: ('png', None),
+        fusion_platform.FILE_TYPE_PDF: ('pdf', None),
+        fusion_platform.FILE_TYPE_GZIP: ('gz', None),
+        fusion_platform.FILE_TYPE_ZIP: ('zip', None),
+        fusion_platform.FILE_TYPE_OTHER: ('*', None),
+    }
+    # @formatter:on
+
+    # STAC file name constants. We do not use ".json" because this is used by services and specific file types. Similarly, the name starts with "." to hide it.
+    _STAC_COLLECTION_FILE_NAME = '.collection.stac'
+    _STAC_ITEM_FILE_NAME_FORMAT = '.{file_name}.stac'
+
     def __init__(self, session):
         """
         Initialises the object.
@@ -249,3 +280,148 @@ class DataFile(Model):
             raise ModelError(i18n.t('models.data_file.failed_download_url'))
 
         return url
+
+    def get_stac_item(self, item_file_name_format=_STAC_ITEM_FILE_NAME_FORMAT, collection_file_name=_STAC_COLLECTION_FILE_NAME):
+        """
+        Converts the data file representation into a STAC item.
+
+        Args:
+            item_file_name_format: The optional item file name format string, where the "file_name" placeholder is replaced with the item's file name.
+            collection_file_name: The optional owning collection file name.
+
+        Returns:
+            A tuple of the STAC item definition as a dictionary and the item file name used in the definition.
+        """
+
+        # Obtain all the relevant information.
+        bounds = self.bounds if hasattr(self, Model._FIELD_BOUNDS) else None
+        crs = self.crs if hasattr(self, Model._FIELD_CRS) else None
+        file_name = self.file_name if hasattr(self, Model._FIELD_FILE_NAME) else None
+        size = self.size if hasattr(self, Model._FIELD_SIZE) else None
+
+        # Attempt to find the file type to get its extension and geospatial type. Default to "Other" if not found.
+        found_file_type = DataFile._FILE_TYPES.get(self.file_type)
+
+        if found_file_type is None:
+            found_file_type = DataFile._FILE_TYPES.get(fusion_platform.FILE_TYPE_OTHER)
+
+        geospatial = found_file_type[1]
+
+        # Get the file extension.
+        extension = os.path.splitext(file_name)[1] if file_name is not None else None
+        extension = found_file_type[0] if extension is None else extension
+
+        if (extension is None) or (extension == '*'):
+            extension = ''
+        else:
+            extension = f".{extension}" if not extension.startswith('.') else extension
+
+        # Work out a suitable name for the file if one is not available.
+        if file_name is None:
+            file_name = f"{self.id}{extension}"
+
+        item_file_name = item_file_name_format.format(file_name=file_name)
+
+        # Start to build the STAC extensions list.
+        stac_extensions = ['https://stac-extensions.github.io/processing/v1.2.0/schema.json']  # For properties#processing.[software,version].
+
+        # Get the bounding box and geometry, if there is one.
+        bbox = []
+        geometry = {}
+
+        if (bounds is not None) and (len(bounds) >= 4):
+            bbox = bounds
+            geometry = {'type': 'Polygon', 'coordinates': [[[bbox[0], bbox[1]], [bbox[2], bbox[1]], [bbox[2], bbox[3]], [bbox[0], bbox[3]], [bbox[0], bbox[1]]]]}
+
+        # Get the datetime from the filename, if possible. We try various iterations of sections the file name until we find something.
+        for file_part in file_name.split('_'):
+            extracted_datetime = datetime_parse(file_part) or datetime_parse(f"{file_part}T00:00:00Z")  # Assume UTC.
+
+            if extracted_datetime is not None:
+                break
+
+        if extracted_datetime is None:
+            extracted_datetime = self.created_at
+
+        # Start to build the properties.
+        properties = {'processing.software': i18n.t('fusion_platform.sdk'), 'processing.version': fusion_platform.__version__, 'datetime': extracted_datetime}
+
+        # Add in the CRS, if there is one.
+        if crs is not None:
+            properties['proj:epsg'] = crs
+            stac_extensions.append('https://stac-extensions.github.io/projection/v1.1.0/schema.json')  # For properties#proj:epsg.
+
+        # Build the links.
+        links = [{'rel': 'self', 'href': item_file_name, 'type': 'application/json'}]
+
+        # Add in the optional owning collection.
+        if collection_file_name is not None:
+            links.append({'rel': 'root', 'href': collection_file_name, 'type': 'application/json'})
+            links.append({'rel': 'parent', 'href': collection_file_name, 'type': 'application/json'})
+
+        # Start to build the asset from the associated file.
+        asset = {'href': file_name, 'roles': []}
+
+        # Extract out the relevant values depending upon the file type.
+        raster_bands = None
+        eo_bands = None
+
+        if (geospatial == DataFile._GEOSPATIAL_RASTER) and hasattr(self, Model._FIELD_SELECTORS) and (self.selectors is not None):
+            for selector in self.selectors:
+                raster_band = {}
+                eo_band = {}
+
+                if hasattr(self, Model._FIELD_RESOLUTION):
+                    raster_band['spatial_resolution'] = self.resolution
+
+                if selector.get(Model._FIELD_UNIT) is not None:
+                    raster_band['unit'] = selector.get(Model._FIELD_UNIT)
+
+                if (selector.get(Model._FIELD_MINIMUM) is not None) and (selector.get(Model._FIELD_MAXIMUM) is not None) and (
+                        selector.get(Model._FIELD_MEAN) is not None) and (selector.get(Model._FIELD_SD) is not None):
+                    raster_band['statistics'] = {
+                        'minimum': selector.get(Model._FIELD_MINIMUM),
+                        'maximum': selector.get(Model._FIELD_MAXIMUM),
+                        'mean': selector.get(Model._FIELD_MEAN),
+                        'stddev': selector.get(Model._FIELD_SD)
+                    }
+
+                if (selector.get(Model._FIELD_HISTOGRAM_MINIMUM) is not None) and (selector.get(Model._FIELD_HISTOGRAM_MAXIMUM) is not None) and (
+                        selector.get(Model._FIELD_HISTOGRAM) is not None):
+                    raster_band['histogram'] = {
+                        'count': len(selector.get(Model._FIELD_HISTOGRAM)),
+                        'min': selector.get(Model._FIELD_HISTOGRAM_MINIMUM),
+                        'max': selector.get(Model._FIELD_HISTOGRAM_MAXIMUM),
+                        'buckets': selector.get(Model._FIELD_HISTOGRAM),
+                    }
+
+                if selector.get(Model._FIELD_CATEGORY) is not None:
+                    eo_band['name'] = selector.get(Model._FIELD_CATEGORY)
+
+                raster_bands = [raster_band] if raster_bands is None else [raster_band] + raster_bands
+                eo_bands = [eo_band] if eo_bands is None else [eo_band] + eo_bands
+
+            stac_extensions.append('https://stac-extensions.github.io/eo/v1.1.0/schema.json')  # For assets#eo:bands.
+            stac_extensions.append('https://stac-extensions.github.io/raster/v1.1.0/schema.json')  # For assets#raster:bands.
+
+        if raster_bands is not None:
+            asset['raster:bands'] = raster_bands
+            asset['eo:bands'] = eo_bands
+
+        # Add in the file size, if there is one.
+        if size is not None:
+            asset['file:size'] = size
+            stac_extensions.append('https://stac-extensions.github.io/file/v2.1.0/schema.json')  # For assets#file:size.
+
+        # Build the STAC item.
+        return {
+            'type': 'Feature',
+            'stac_version': '1.0.0',
+            'stac_extensions': stac_extensions,
+            'id': self.id,
+            'bbox': bbox,
+            'geometry': geometry,
+            'properties': properties,
+            'links': links,
+            'assets': {'asset': asset}
+        }, item_file_name

{fusion-platform-python-sdk-1.12.2 → fusion-platform-python-sdk-1.13.5}/fusion_platform/models/model.py

@@ -41,8 +41,11 @@ class Model(Base):
 
     # Useful fields and templates.
     _FIELD_AVAILABLE_DISPATCHERS = 'available_dispatchers'
+    _FIELD_BOUNDS = 'bounds'
+    _FIELD_CATEGORY = 'category'
     _FIELD_CONSTRAINED_NAMES = 'constrained_names'
     _FIELD_CONSTRAINED_VALUES = 'constrained_values'
+    _FIELD_CRS = 'crs'
     _FIELD_DATA_TYPE = 'data_type'
     _FIELD_DISPATCH_INTERMEDIATE = 'dispatch_intermediate'
     _FIELD_DISPATCHERS = 'dispatchers'
@@ -50,23 +53,37 @@ class Model(Base):
     _FIELD_DOCUMENTATION_DESCRIPTION = 'documentation_description'
     _FIELD_ERROR = 'error'
     _FIELD_EXECUTIONS = 'executions'
+    _FIELD_EXTENSIONS = 'extensions'
+    _FIELD_FILE_NAME = 'file_name'
     _FIELD_FILE_TYPE = 'file_type'
+    _FIELD_GEOSPATIAL = 'geospatial'
     _FIELD_GROUP_COUNT = 'group_count'
     _FIELD_GROUP_ID = 'group_id'
     _FIELD_GROUP_INDEX = 'group_index'
     _FIELD_HAS_EXECUTIONS = 'has_executions'
+    _FIELD_HISTOGRAM = 'histogram'
+    _FIELD_HISTOGRAM_MINIMUM = 'histogram_minimum'
+    _FIELD_HISTOGRAM_MAXIMUM = 'histogram_maximum'
     _FIELD_ID = 'id'
     _FIELD_INPUT = 'input'
     _FIELD_INPUTS = 'inputs'
     _FIELD_KEYWORDS = 'keywords'
+    _FIELD_MAXIMUM = 'maximum'
+    _FIELD_MEAN = 'mean'
+    _FIELD_MINIMUM = 'minimum'
     _FIELD_NAME = 'name'
     _FIELD_OPTIONS = 'options'
     _FIELD_OUTPUTS = 'outputs'
     _FIELD_PROCESS_STATUS = 'process_status'
+    _FIELD_RESOLUTION = 'resolution'
+    _FIELD_SD = 'sd'
+    _FIELD_SELECTOR = 'selector'
+    _FIELD_SELECTORS = 'selectors'
     _FIELD_SSD_ID = 'ssd_id'
     _FIELD_STARTED_AT = 'started_at'
     _FIELD_PUBLISHABLE = 'publishable'
     _FIELD_SIZE = 'size'
+    _FIELD_UNIT = 'unit'
     _FIELD_VALIDATION = 'validation'
     _FIELD_VALUE = 'value'
 
@@ -148,11 +165,12 @@ class Model(Base):
 
         return attributes
 
-    def __build_body(self, **kwargs):
+    def __build_body(self, create=False, **kwargs):
         """
-        Builds a request body suitable for sending to the API. All current model attributes are included, with the keywords arguments overridding their value.
+        Builds a request body suitable for sending to the API. All current model attributes are included, with the keywords arguments overriding their value.
 
         Args:
+            create: Whether the body is being built for a create request. This allows the id to be overridden.
             kwargs: The model attributes which override those already in the template.
 
         Returns:
@@ -167,9 +185,11 @@ class Model(Base):
             if (self.__model is not None) and (key in self.__model):
                 body[Model._REQUEST_KEY_NAME.format(model=model_name, key=key)] = self.__model.get(key)
 
-        # Now override any of the passed in attributes, ignoring anything which is read-only or hidden.
+        # Now override any of the passed in attributes, ignoring anything which is read-only or hidden. The exception here is the id, which can be overridden
+        # during a create operation.
         for key in kwargs:
-            if (Model._METADATA_READ_ONLY not in schema.fields[key].metadata) and (Model._METADATA_HIDE not in schema.fields[key].metadata):
+            if (create and (key == Model._FIELD_ID)) or (
+                    (Model._METADATA_READ_ONLY not in schema.fields[key].metadata) and (Model._METADATA_HIDE not in schema.fields[key].metadata)):
                 body[Model._REQUEST_KEY_NAME.format(model=model_name, key=key)] = kwargs[key]
 
         return body
@@ -211,7 +231,7 @@ class Model(Base):
             raise ModelError(i18n.t('models.model.already_persisted'))
 
         # Form the post body dictionary from the current object and the keyword arguments.
-        body = self.__build_body(**kwargs)
+        body = self.__build_body(create=True, **kwargs)
 
         # Make sure there is a create which can be performed. This requires a non-empty body.
         if len(body) <= 0:

{fusion-platform-python-sdk-1.12.2 → fusion-platform-python-sdk-1.13.5}/fusion_platform/models/organisation.py

@@ -113,7 +113,7 @@ class Organisation(Model):
     _PATH_SERVICES = f"{_PATH_BASE}/services/latest"
     _PATH_DISPATCHERS = f"{_PATH_BASE}/services/dispatchers"
 
-    def create_data(self, name, file_type, files, wait=False):
+    def create_data(self, name, file_type, files, wait=False, **kwargs):
         """
         Creates a data object for the organisation and uploads the corresponding files. Optionally waits for the upload and analysis to complete.
 
@@ -122,6 +122,7 @@ class Organisation(Model):
             file_type: The type of files that the data object will hold.
             files: The list of file paths to be uploaded.
             wait: Optionally wait for the upload and analysis to complete? Default False.
+            kwargs: The model attributes which override those already in the template.
 
         Returns:
             The created data object.
@@ -134,8 +135,8 @@ class Organisation(Model):
         data = Data(self._session)
         data._new(organisation_id=self.id)
 
-        # Now attempt to create the data item.
-        data._create(name, file_type, files, wait)
+        # Now attempt to create the data item with any overriding keyword arguments.
+        data._create(name, file_type, files, wait=wait, **kwargs)
 
         return data
 

{fusion-platform-python-sdk-1.12.2 → fusion-platform-python-sdk-1.13.5}/fusion_platform/models/process.md

@@ -29,3 +29,5 @@
 * **test_run**: Is this a test run of a service?
 * **price**: The price in FPUs to execute this process given its inputs and options.
 * **deletable**: Is this process scheduled for deletion?
+* **non_aggregator_count**: The count of non-aggregator executions within the current or last execution.
+* **aggregator_count**: The count of aggregator executions within the current or last execution.

{fusion-platform-python-sdk-1.12.2 → fusion-platform-python-sdk-1.13.5}/fusion_platform/models/process.py

@@ -473,8 +473,10 @@ class ProcessSchema(Schema):
     has_executions = fields.String(required=True, metadata={'hide': True})  # Changed to hide as an attribute.
     has_executions_organisation_id = fields.String(required=True, metadata={'hide': True})  # Changed to hide as an attribute.
     executions = fields.List(fields.Nested(ProcessExecutionStatusSchema()), allow_none=True, metadata={'hide': True})  # Changed to hide as an attribute.
-
+    non_aggregator_count = fields.Integer(allow_none=True, metadata={'read_only': True})  # Changed to prevent this being updated.
+    aggregator_count = fields.Integer(allow_none=True, metadata={'read_only': True})  # Changed to prevent this being updated.
     # Removed creator.
+
     # Removed search.
 
     available_dispatchers = fields.List(fields.Nested(ProcessDispatcherSchema()), allow_none=True, metadata={'hide': True})  # Added pseudo-field.
@@ -528,14 +530,16 @@ class Process(Model):
         fusion_platform.FILE_TYPE_GEOTIFF: [fusion_platform.FILE_TYPE_GEOTIFF, fusion_platform.FILE_TYPE_DEM, fusion_platform.FILE_TYPE_JPEG2000],
         fusion_platform.FILE_TYPE_JPEG2000: [fusion_platform.FILE_TYPE_JPEG2000],
         fusion_platform.FILE_TYPE_DEM: [fusion_platform.FILE_TYPE_DEM],
-        fusion_platform.FILE_TYPE_GEOJSON: [fusion_platform.FILE_TYPE_GEOJSON, fusion_platform.FILE_TYPE_KML, fusion_platform.FILE_TYPE_KMZ,
-                                            fusion_platform.FILE_TYPE_ESRI_SHAPEFILE],
+        fusion_platform.FILE_TYPE_GEOJSON: [fusion_platform.FILE_TYPE_GEOJSON, fusion_platform.FILE_TYPE_KML, fusion_platform.FILE_TYPE_KMZ, fusion_platform.FILE_TYPE_ESRI_SHAPEFILE],
         fusion_platform.FILE_TYPE_KML: [fusion_platform.FILE_TYPE_KML],
         fusion_platform.FILE_TYPE_KMZ: [fusion_platform.FILE_TYPE_KMZ],
         fusion_platform.FILE_TYPE_CSV: [fusion_platform.FILE_TYPE_CSV],
         fusion_platform.FILE_TYPE_ESRI_SHAPEFILE: [fusion_platform.FILE_TYPE_ESRI_SHAPEFILE],
         fusion_platform.FILE_TYPE_JPEG: [fusion_platform.FILE_TYPE_JPEG],
         fusion_platform.FILE_TYPE_PNG: [fusion_platform.FILE_TYPE_PNG],
+        fusion_platform.FILE_TYPE_PDF: [fusion_platform.FILE_TYPE_PDF],
+        fusion_platform.FILE_TYPE_GZIP: [fusion_platform.FILE_TYPE_GZIP],
+        fusion_platform.FILE_TYPE_ZIP: [fusion_platform.FILE_TYPE_ZIP],
         fusion_platform.FILE_TYPE_OTHER: [fusion_platform.FILE_TYPE_OTHER],
     }
     # @formatter:on
@@ -655,16 +659,19 @@ class Process(Model):
         # Return the copy.
         return process
 
-    def create(self):
+    def create(self, **kwargs):
         """
         Attempts to persist the template process in the Fusion Platform<sup>&reg;</sup> so that it can be executed.
 
+        Args:
+            kwargs: The model attributes which override those already in the template.
+
         Raises:
             RequestError: if the create fails.
             ModelError: if the model could not be created and validated by the Fusion Platform<sup>&reg;</sup>.
         """
         # Attempt to issue the create.
-        self._create()
+        self._create(**kwargs)
 
     def __dispatchers(self, dispatchers):
         """

{fusion-platform-python-sdk-1.12.2 → fusion-platform-python-sdk-1.13.5}/fusion_platform/models/service.py

@@ -203,8 +203,8 @@ class ServiceSchema(Schema):
     version = fields.Integer(required=True, metadata={'read_only': True})  # Changed to prevent this being updated.
     approval_status = fields.String(required=True, metadata={'read_only': True})  # Changed to prevent this being updated.
     # Removed latest.
-    # Removed dispatcher.
     featured = fields.String(allow_none=True)
+    # Removed dispatcher.
     show_in_latest = fields.Boolean(allow_none=True)  # Changed to optional.
     name = fields.String(required=True)
 
@@ -234,6 +234,7 @@ class ServiceSchema(Schema):
 
     # Removed creator.
     # Removed approver.
+
     # Removed search.
 
     documentation_summary = fields.String(required=True)

{fusion-platform-python-sdk-1.12.2 → fusion-platform-python-sdk-1.13.5}/fusion_platform/translations.py

@@ -15,10 +15,12 @@ i18n.add_translation('session.request_failed', 'API request failed: %{message}',
 i18n.add_translation('session.login_failed', 'Login failed', 'en')
 i18n.add_translation('session.missing_password', 'Password must be specified', 'en')
 i18n.add_translation('session.missing_email_user_id', 'Either an email address or a user id must be specified', 'en')
+i18n.add_translation('fusion_platform.url', 'https://www.d-cat.co.uk', 'en')
 i18n.add_translation('fusion_platform.support', 'Support: support@d-cat.co.uk', 'en')
 i18n.add_translation('fusion_platform.version_date', 'Date: %{version_date}', 'en')
 i18n.add_translation('fusion_platform.version', 'Version: %{version}', 'en')
 i18n.add_translation('fusion_platform.sdk', 'Fusion Platform(r) SDK', 'en')
+i18n.add_translation('fusion_platform.organisation', 'Digital Content Analysis Technology Ltd', 'en')
 i18n.add_translation('models.data_file.failed_download_url', 'Failed to get URL from download file response', 'en')
 i18n.add_translation('models.data_file.no_download', 'No download is in progress', 'en')
 i18n.add_translation('models.data_file.download_already_in_progress', 'Cannot download file as the download is already in progress', 'en')

{fusion-platform-python-sdk-1.12.2 → fusion-platform-python-sdk-1.13.5/fusion_platform_python_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fusion-platform-python-sdk
-Version: 1.12.2
+Version: 1.13.5
 Summary: Python SDK used to interact with the Fusion Platform(r)
 Home-page: https://github.com/d-cat-support/fusion-platform-python-sdk
 Author: Digital Content Analysis Technology Ltd

{fusion-platform-python-sdk-1.12.2 → fusion-platform-python-sdk-1.13.5}/setup.py

@@ -19,7 +19,7 @@ PACKAGE_DIR = pathlib.Path(__file__).parent
 # @formatter:off
 setup(
     name='fusion-platform-python-sdk',
-    version='1.12.2',
+    version='1.13.5',
     description='Python SDK used to interact with the Fusion Platform(r)',
     long_description=(PACKAGE_DIR / 'README.md').read_text(),
     long_description_content_type='text/markdown',